Update README with project overview #230
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add an overview section to the `README.md` file. * **Overview Section** - Add a section titled "Overview". - Mention that the repository is a Python project. - Include a brief description of the purpose of the project, which is to provide tools for working with Bitcoin in Python. - Provide a link for more information on rate limits and tokens: http://www.blockcypher.com/dev/bitcoin#rate-limits-and-tokens. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/vbuterin/pybitcointools?shareId=XXXX-XXXX-XXXX-XXXX).
Add `blockcypher.py` module to handle rate limits and tokens for BlockCypher's Bitcoin API. * **`blockcypher.py`**: - Implement `set_api_token` function to set the API token. - Implement `get_api_token` function to retrieve the current API token. - Implement `get_rate_limit_status` function to check the current rate limit status. * **`README.md`**: - Add "Rate Limits and Tokens" section with usage instructions for `blockcypher.py`. - Include examples of how to use the functions in `blockcypher.py`. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Johnson1s/pybitcointools?shareId=XXXX-XXXX-XXXX-XXXX).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add an overview section to the
README.mdfile.For more details, open the Copilot Workspace session.