Updated install instructions, add shields #2
Conversation
This file contains hidden or 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
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.
This pull request includes updates to the
README.mdfile and thepyproject.tomlconfiguration file to enhance documentation and project metadata. The most important changes include adding badges for Python version and package version, updating the description and adding classifiers inpyproject.toml, and including installation instructions in theREADME.md.Documentation updates:
README.md: Added badges for Python version and package version, updated the description of the@maindecorator, and included installation instructions.README.md: Modified the docstring in the example function to clarify when the function will run.Project metadata updates:
pyproject.toml: Added a homepage URL, updated the description, and included classifiers for development status, intended audience, license, and language.