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

Improve python package's README #293

Open

reyammer opened this issue Mar 7, 2024 · 0 comments

Labels

documentation python-package

Collaborator

reyammer commented Mar 7, 2024

The text that shows up at https://pypi.org/project/magika/ is OK, but we can improve by:

document the current version and have a pointer to the changelog (or include it within the readme itself).
There are some bits that tend to fall out of sync: citation block, version that shows up in the help of magika CLI

reyammer added documentation python-package labels

github-actions bot added the needs triage label

reyammer removed the needs triage label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment