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

Added more extensive documentation to README.md #13

Merged
merged 1 commit into from
Sep 28, 2024
Merged

Added more extensive documentation to README.md #13

merged 1 commit into from
Sep 28, 2024

Conversation

pasabanov
Copy link
Owner

PR Type

  • Bug fix
  • Feature
  • Documentation
  • Localization / Internationalization
  • Chore (refactoring, formatting, cleanup, etc.)
  • Other (please describe): _______

Related: #12

Describe changes
Added more extensive documentation to README.md:

  1. Brief module descriptions with links to the format specifications.
  2. Simple code examples.

@pasabanov pasabanov added documentation Improvements or additions to documentation essential Licensing, readme, guidelines, project description labels Sep 28, 2024
@pasabanov pasabanov self-assigned this Sep 28, 2024
@pasabanov pasabanov merged commit 4b1368d into main Sep 28, 2024
@pasabanov pasabanov deleted the readme branch September 28, 2024 21:03
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 essential Licensing, readme, guidelines, project description
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant