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

Add proper README documentation #32

Merged
merged 1 commit into from
Sep 29, 2024
Merged

Add proper README documentation #32

merged 1 commit into from
Sep 29, 2024

Conversation

doubleedesign
Copy link
Contributor

Summary

What is the nature of this pull request?

  • New feature
  • Enhancement to an existing feature
  • Bug fix
  • Configuration update
  • Dependency update
  • Documentation update

Description of change

This PR updates the README to include the basics of installation, usage, and contributing as is standard practice, particularly for the project NPM page which automatically uses it.

Planner card link

N/A

Readiness

  • The application runs successfully with my change.
  • N/A I have included code comments where appropriate.
  • N/A Where I have copied and pasted code from other sources, I have included a comment with a link to the original source.
  • I have read and followed the principles and guidelines about submitting code.
  • N/A I have added unit tests for new components and/or functionality.
  • N/A All existing and new unit tests pass (including updating tests for any necessary breaking changes).

@doubleedesign doubleedesign requested a review from a team as a code owner September 29, 2024 04:50
@doubleedesign doubleedesign merged commit cb4bfc6 into main Sep 29, 2024
1 check passed
@doubleedesign doubleedesign deleted the update-readme branch September 29, 2024 04:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant