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.

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

docs: improve README file #32

Merged
merged 11 commits into from
Aug 3, 2024
Merged

docs: improve README file #32

merged 11 commits into from
Aug 3, 2024

Conversation

peter-rr
Copy link
Collaborator

Adding a complete version of the README file, so we can start with the donation process of this repo.

Related issue(s)
Relates to #16

@peter-rr peter-rr changed the title docs: Improve README file docs: improve README file Apr 26, 2024
@peter-rr
Copy link
Collaborator Author

@smoya Feel free to add any kind of suggestion and let me know if anything missing on the document :)

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
@smoya
Copy link
Owner

smoya commented Apr 29, 2024

Missing the following sections:

  • Installation
  • Usage (with examples)
  • Contributing

README.md Outdated Show resolved Hide resolved
@peter-rr peter-rr requested a review from smoya April 30, 2024 09:17
@peter-rr
Copy link
Collaborator Author

Missing the following sections:

  • Installation
  • Usage (with examples)
  • Contributing

Missing sections already added. Ready for review 🚀

@peter-rr peter-rr requested a review from Amzani May 21, 2024 16:01
@peter-rr peter-rr force-pushed the docs/update-readme branch from a0e9c46 to 69bef4b Compare June 5, 2024 12:23
@smoya smoya merged commit e83c35e into smoya:main Aug 3, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants