Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated install instructions, add shields #2

Merged
merged 2 commits into from
Nov 15, 2024
Merged

Conversation

flipbit03
Copy link
Owner

@flipbit03 flipbit03 commented Nov 15, 2024

This pull request includes updates to the README.md file and the pyproject.toml configuration 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 in pyproject.toml, and including installation instructions in the README.md.

Documentation updates:

  • README.md: Added badges for Python version and package version, updated the description of the @main decorator, 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.

@flipbit03 flipbit03 self-assigned this Nov 15, 2024
Copy link

@nathan2slime nathan2slime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice badges

@flipbit03 flipbit03 merged commit a394eb6 into main Nov 15, 2024
5 checks passed
@flipbit03 flipbit03 deleted the update_package_metadata branch November 15, 2024 03:27
flipbit03 added a commit that referenced this pull request Nov 16, 2024
flipbit03 added a commit that referenced this pull request Dec 7, 2024
flipbit03 added a commit that referenced this pull request Dec 7, 2024
…uggest it. (#7)

* Change the function name to be able to be more easily imported (some IDEs actively avoid suggesting importing something named "main")

* Wordsmithing.

* Wordsmithing #2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants