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

Improve the readme #41

Merged
merged 2 commits into from
Mar 20, 2024
Merged

Improve the readme #41

merged 2 commits into from
Mar 20, 2024

Conversation

nizarmah
Copy link
Owner

Improves the README by:

  • Adding a test workflow badge
  • Better separating the sections
  • Making examples expandable

Also prepares README for v3 release.

nizarmah
nizarmah commented Mar 20, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
nizarmah
nizarmah commented Mar 20, 2024
View reviewed changes
Copy link
Owner Author

@nizarmah nizarmah left a comment

Choose a reason for hiding this comment

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

👍🏼

@nizarmah nizarmah merged commit ea168b3 into master Mar 20, 2024
8 checks passed
@nizarmah nizarmah deleted the update-readme branch March 20, 2024 17:25
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
@nizarmah