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.

Sign up for GitHub

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

Jump to bottom

chore: update project metadata and README for citation and versioning #40

Merged
merged 1 commit into from
Nov 11, 2024
Merged

chore: update project metadata and README for citation and versioning #40

merged 1 commit into from
Nov 11, 2024

Conversation

Bjarten
Copy link
Owner

@Bjarten Bjarten commented Nov 11, 2024

This PR includes multiple maintenance updates for the project:

  • Added repository URL: Linked the GitHub repository in pyproject.toml for improved metadata on PyPI.
  • Updated README: Added citation information to the README, allowing users to easily cite this project in publications.
  • Enhanced versioning: Implemented dynamic versioning in README.md to automatically reflect the current package version in the citation section, based on the version in __init__.py.

Changes:

  • pyproject.toml: Added repository URL for PyPI metadata.
  • README.md: Included citation section with version sourced dynamically.
  • Version control: Updated configuration for streamlined version syncing.

This update provides enhanced user documentation and metadata for better project maintainability.

@Bjarten Bjarten merged commit 6834653 into main Nov 11, 2024
5 checks passed
@Bjarten Bjarten deleted the chore/update-metadata-and-readme branch November 11, 2024 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Bjarten