gradus - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "gradus",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Look up a word using the wordnik API.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -1,7 +0,7 @@
-# gradus: pre-alpha
+# gradus: alpha version
 
 Look up a word using the [wordnik][] API.
 
-**Note:** This is pre-alpha; nothing except from a word's definition works yet,
-but I use this so often that I wanted it published.
+**Note:** This is alpha quality: it has no unit tests, but it works and I use it
+daily.
 
@@ -28,2 +28,32 @@ ## Install
 
+Run with `--help` to see all options:
+
+```
+$ gradus --help
+
+gradus: Get information about a word using the Wordnik API
+
+You must have a valid Wordnik API key to use this application, and will be
+prompted for one if it isn't already stored in your `~/.gradusrc`
+
+Usage: gradus [options] <term>
+
+Options:
+  --help                    Show this help text
+  --version                 Show version number and exit
+  --section -s <section>    Informational section (default: 'definitions')
+
+Valid Sections:
+
+definitions         Get the definitions available (default)
+topExample          See the top usage example
+relatedWords        Get related words
+pronunciations      Pronunciation
+hyphenation         Valid hyphenations
+frequency           No idea
+phrases             Phrases using the word
+
+Powered by Wordnik: https://www.wordnik.com/
+```
+
 ## License
@@ -30,0 +60,0 @@

No alert changes

Improved metrics

Total package byte prevSize

28735

increased by2.86%

Number of lines in readme file

70

increased by75%

No dependency changes