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

Update readme to show how to use the lib #56

Open
2 tasks
ricardodalarme opened this issue Jun 12, 2023 · 0 comments
Open
2 tasks

Update readme to show how to use the lib #56

ricardodalarme opened this issue Jun 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ricardodalarme
Copy link
Collaborator

The problem

Currently, our readme is not attractive at all for people who want to use the library, it only shows things that we use for internal development.

Sought-for solution

  • Add in the readme some visual examples, and the features our player has
  • Move the development related stuff to another file
@ricardodalarme ricardodalarme added the documentation Improvements or additions to documentation label Jun 12, 2023
ricardodalarme added a commit that referenced this issue Jun 13, 2023
@ricardodalarme
docs: do not include development instructions in the README
256136f 
Related #56
@ricardodalarme ricardodalarme mentioned this issue Jun 13, 2023
Merged
ricardodalarme added a commit that referenced this issue Jun 13, 2023
@ricardodalarme
docs: do not include development instructions in the README
98eecb9 
Related #56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ricardodalarme