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

Make a proper documentation #4

Open
AbdKayali3 opened this issue Feb 17, 2023 · 1 comment
Open

Make a proper documentation #4

AbdKayali3 opened this issue Feb 17, 2023 · 1 comment
Labels
Documentation Improvements or additions to documentation Features to add Features that is needed Ongoing Currently working on this issue

Comments

@AbdKayali3
Copy link
Owner

Make a proper documentation and maybe post in as GitHub pages or something.
In the documentation we should describe how the library works, what are the parameters they can put, some examples, and how to customize it.
@AbdKayali3 AbdKayali3 added Documentation Improvements or additions to documentation Features to add Features that is needed labels Feb 17, 2023
@AbdKayali3
Copy link
Owner Author

The documentation has been updated with the proper info.

  • A screenshot
  • Parameters description
  • Options table
  • A proper example

@AbdKayali3 AbdKayali3 added the Ongoing Currently working on this issue label Mar 2, 2023
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 Features to add Features that is needed Ongoing Currently working on this issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@AbdKayali3