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 README #26

Open

ErikKalkoken wants to merge 1 commit into antihax:master from ErikKalkoken:improve-readme

Contributor

ErikKalkoken commented Feb 18, 2025

I would like to suggest a few changes to the README:

Added table of contents and grouped all user guide related sections under a new heading "User Guide"
Added link to goesi on "Go packages", which I think is very helpful for understanding the API
Added badges on the top for quick access to key information and links
Replaces the naked URLs and changes some minor formatting to satisfy my markdown linter

Another suggestion: I think the README would look even cleaner if the Ko-Fi link could be moved to the Github sponsor section of this project.


          Improve README

d3400fb

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

Labels

None yet