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

Refactor README.md for make it more focused on basic initiation for new users #51

Open
heliomar-pena opened this issue May 5, 2024 · 0 comments
Open

Refactor README.md for make it more focused on basic initiation for new users #51

heliomar-pena opened this issue May 5, 2024 · 0 comments
Assignees
@heliomar-pena
Milestone
Refactoring docum...

Comments

@heliomar-pena
Copy link
Owner

README.md should be a quick source from which users can start using the library, instead of containing ALL the documentation. Later, the documentation will be moved to a documentation website in case someone wants to learn more about the library.
@heliomar-pena heliomar-pena self-assigned this Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@heliomar-pena heliomar-pena

Labels
None yet
Projects
None yet
Milestone
Refactoring documentation
Development

No branches or pull requests
1 participant
@heliomar-pena