citty
citty copied to clipboard
docs: add usage section
๐ Linked issue
fix partially #62
โ Type of change
- [x] ๐ Documentation (updates to the documentation, readme, or JSdoc annotations)
- [ ] ๐ Bug fix (a non-breaking change that fixes an issue)
- [ ] ๐ Enhancement (improving an existing functionality like performance)
- [ ] โจ New feature (a non-breaking change that adds functionality)
- [ ] ๐งน Chore (updates to the build process or auxiliary tools and libraries)
- [ ] โ ๏ธ Breaking change (fix or feature that would cause existing functionality to change)
๐ Description
This PR add a usage section to the README.
๐ Checklist
- [x] I have linked an issue or discussion.
- [x] I have updated the documentation accordingly.
Codecov Report
Merging #70 (26a44f2) into main (f4c4447) will not change coverage. The diff coverage is
n/a.
:exclamation: Current head 26a44f2 differs from pull request most recent head 99a43fc. Consider uploading reports for the commit 99a43fc to get more accurate results
@@ Coverage Diff @@
## main #70 +/- ##
==========================
==========================
Maybe, I could add that positional arguments are required by default, not if there is a default value.
related to #73
Love these updates! answers most of my questions I had. Merging this will help so many others.