Skip to content

Improve and update the README.md #29

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
Merged
CosimoTiger merged 2 commits into from
Jan 6, 2025
Merged

Improve and update the README.md #29

CosimoTiger merged 2 commits into from
Jan 6, 2025

Conversation

@CosimoTiger
Copy link
Owner

@CosimoTiger CosimoTiger commented Jan 6, 2025 •
edited
Loading

  • remove the need for specifying dependency versions
  • redirect installation guide to the JitPack website for this repository
  • go into greater detail with some descriptions
  • add contributing, license and support sections
  • add those cool GitHub badges that everyone's using under the repository title

@CosimoTiger
📘 docs: overhaul and improvement of README.md
ec90514 
- add code examples
- remove the need for specifying dependency versions
- go into greater detail with some descriptions
- add contributing, license and support sections
@CosimoTiger
Shorten the README.md again
03e096c
@CosimoTiger CosimoTiger added the documentation Improvements or additions to documentation label Jan 6, 2025
@CosimoTiger CosimoTiger self-assigned this Jan 6, 2025
@CosimoTiger CosimoTiger merged commit 659012f into main Jan 6, 2025
1 check passed
@CosimoTiger CosimoTiger deleted the feature/improve-README branch January 6, 2025 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@CosimoTiger CosimoTiger

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

First release and deployment

Development

Successfully merging this pull request may close these issues.

2 participants

@CosimoTiger