Add usage documentation

knutkirkhorn · Sep 9, 2019 · a18cf36 · a18cf36
1 parent 7551ec4
commit a18cf36
Showing 1 changed file with 25 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
-# week-number-cli
-📅 Get the ISO 8601 week number of a date CLI
+# week-number-cli [![Build Status](https://travis-ci.org/Knutakir/week-number-cli.svg?branch=master)](https://travis-ci.org/Knutakir/week-number-cli)
+> 📅 Get the ISO 8601 week number of a date CLI
+
+## Installation
+```
+$ npm install --global @knutkirkhorn/week-number-cli
+```
+
+## Usage
+```
+$ week-number --help
+
+        Usage
+          $ week-number
+          $ week-number <date>
+        Examples
+          $ week-number
+          $ week-number "September 3, 2019 23:15:30"
+```
+
+## Related
+- [week-number](https://github.com/Knutakir/week-number) - API for this module
+
+## License
+MIT © [Knut Kirkhorn](LICENSE)