citty icon indicating copy to clipboard operation
citty copied to clipboard

docs: add usage section

Open Barbapapazes opened this issue 2 years ago โ€ข 8 comments

๐Ÿ”— 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.

Barbapapazes avatar Sep 12 '23 12:09 Barbapapazes

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   +/-   ##
==========================
==========================

codecov[bot] avatar Sep 12 '23 12:09 codecov[bot]

Maybe, I could add that positional arguments are required by default, not if there is a default value.

Barbapapazes avatar Sep 12 '23 23:09 Barbapapazes

related to #73

Barbapapazes avatar Sep 13 '23 00:09 Barbapapazes

Love these updates! answers most of my questions I had. Merging this will help so many others.

DanielRivers avatar Mar 14 '24 12:03 DanielRivers