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

Improve the README.md documentation structure #15

Closed
VGavara opened this issue Nov 30, 2022 · 0 comments · Fixed by #19
Closed

Improve the README.md documentation structure #15

VGavara opened this issue Nov 30, 2022 · 0 comments · Fixed by #19
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@VGavara
Copy link
Owner

VGavara commented Nov 30, 2022

Perform these operations in README.md:

  • Add npm, release and license badges
  • Move the current heading information to a subsection called "About"
  • Keep the current "At a glance" section but convert it into subseciton
  • Create a subsection called "Installation"
  • Create a subsection called "Usage" describing in detail each class
  • Create a subsection called "Support" with a link to the repository issues
  • Create a subsection called "License" including a link to the MIT
  • Create a subsection called "Contact" with the repo owner email and a link to GitHub and LinkedIn.
@VGavara VGavara added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 30, 2022
@VGavara VGavara self-assigned this Nov 30, 2022
@VGavara VGavara linked a pull request Dec 1, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant