Merge pull request #13 from ALiberalVoluntarist/master

version1.0.0

CHANGELOG.md

@@ -7,69 +7,58 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## Table of Contents
 
 - [Unreleased](#unreleased)
-- [1.0.0 - YYYY-MM-DD](#100---yyyy-mm-dd)
+- [1.0.0 - 2024-12-23](#100---2024-12-23)
+- [0.5.2 - 2024-09-02](#052---2024-09-02)
+- [0.1.0 - 2024-04-09](#010---2024-04-09)
+
+---
 
 ## [Unreleased]
 
 ### Added
-
 - (Include new features or significant user-visible enhancements here.)
 
 ### Changed
-
 - (Detail modifications that are non-breaking but relevant to the end-users.)
 
 ### Deprecated
-
 - (List features that are in the process of being phased out or replaced.)
 
 ### Removed
-
 - (Indicate features or capabilities that were taken out of the project.)
 
 ### Fixed
-
 - (Document bugs that were fixed since the last release.)
 
 ### Security
-
 - (Notify of any improvements related to security vulnerabilities or potential risks.)
 
 ---
 
-## [1.0.0] - YYYY-MM-DD
+## [1.0.0] - 2024-12-23
 
 ### Added
-
-- Initial release
+- Fixed miner-related bugs.
+- Improved documentation and updated the PyPI version.
+- Implemented bug fixes and improvements based on feedback from the Yenpoint user test.
 
 ---
 
-### Template for New Releases:
-
-Replace `X.X.X` with the new version number and `YYYY-MM-DD` with the release date:
-
-```
-## [X.X.X] - YYYY-MM-DD
+## [0.5.2] - 2024-09-02
 
 ### Added
-- 
+- Basic functions developed by the Script team.
 
-### Changed
-- 
+---
 
-### Deprecated
-- 
+## [0.1.0] - 2024-04-09
 
-### Removed
-- 
+### Added
+- Initial release.
 
-### Fixed
-- 
+---
 
-### Security
-- 
-```
+### Template for New Releases
+
+Replace `X.X.X` with the new version number and `YYYY-MM-DD` with the release date:
 
-Use this template as the starting point for each new version. Always update the "Unreleased" section with changes as they're implemented,
-and then move them under the new version header when that version is released.

README.md

@@ -4,10 +4,8 @@
 [![PyPI version](https://img.shields.io/pypi/v/bsv-sdk)](https://pypi.org/project/bsv-sdk)
 [![Python versions](https://img.shields.io/pypi/pyversions/bsv-sdk)](https://pypi.org/project/bsv-sdk)
 
-Welcome to the BSV Blockchain Libraries Project, the comprehensive Python SDK designed to provide an updated and unified layer for
-developing scalable applications on the BSV Blockchain. This SDK addresses the limitations of previous tools by offering a fresh,
-peer-to-peer approach, adhering to SPV, and ensuring privacy and scalability.
 
+Welcome to the BSV Blockchain Libraries Project, the comprehensive Python SDK designed to provide an updated and unified layer for developing scalable applications on the BSV Blockchain. This SDK addresses the limitations of previous tools by offering a fresh, peer-to-peer approach, adhering to SPV, and ensuring privacy and scalability.
 ## Table of Contents
 
 1. [Objective](#objective)
@@ -19,12 +17,15 @@ peer-to-peer approach, adhering to SPV, and ensuring privacy and scalability.
 
 ## Objective
 
-The BSV Blockchain Libraries Project aims to structure and maintain a middleware layer of the BSV Blockchain technology stack. By
-facilitating the development and maintenance of core libraries, it serves as an essential toolkit for developers looking to build on the BSV
-Blockchain.
+The BSV Blockchain Libraries Project aims to structure and maintain a middleware layer of the BSV Blockchain technology stack. By facilitating the development and maintenance of core libraries, it serves as an essential toolkit for developers looking to build on the BSV Blockchain.
 
 ## Getting Started
 
+### Requirements
+
+Python 3.9 or higher
+pip package manager
+
 ### Installation
 
 ```bash
@@ -80,11 +81,28 @@ For a more detailed tutorial and advanced examples, check our [Documentation](#d
 
 ## Features & Deliverables
 
-- **Main Project Feature**: Description of the feature
+### Advanced Transaction Building:
+
+* Support for P2PKH, P2PK, OP_RETURN, and BareMultisig scripts
+* Automated fee calculation and change output management
+* Custom script development
+* Support for various SIGHASH types
+
+
+### HD Wallet Capabilities:
+
+* Full BIP32/39/44 implementation for hierarchical deterministic wallets
+* Multiple language support for mnemonic phrases (English, Chinese)
+* Advanced key derivation and management
+
 
-- **Main Project Feature 2**: Description of the feature
+### SPV & Validation:
+
+* Built-in SPV verification with BEEF format support
+* Merkle proof validation
+* Efficient transaction broadcast with Arc
+* Support for chain tracking and verification
 
-- **Secondary Project Feature**: Description of the feature
 
 ## Documentation
 
@@ -107,16 +125,11 @@ contributions are welcome.
 
 For more details, check the [contribution guidelines](./CONTRIBUTING.md).
 
-For information on past releases, check out the [changelog](./CHANGELOG.md). For future plans, check the [roadmap](./ROADMAP.md)!
-
 ## Support & Contacts
-
-Project Owners: `<names and email addresses>`
-
-Development Team Lead: `<name and email>`
-
+Project Owners: Thomas Giacomo and Darren Kellenschwiler
+Development Team Lead: sCrypt
+Maintainer: Ken Sato @ Yenpoint inc. & Yosuke Sato @ Yenpoint inc.
 For questions, bug reports, or feature requests, please open an issue on GitHub or contact us directly.
-
 ## License
 
 The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.