sergeant - npm Package Compare versions

Comparing version 15.2.0 to 15.2.1

package.json

 {
   "name": "sergeant",
-  "version": "15.2.0",
+  "version": "15.2.1",
   "description": "",
@@ -5,0 +5,0 @@ "main": "main.js",

README.md

 # sergeant
 
-A CLI solution with simple argument parsing and built in help messages
+A CLI solution with simple argument parsing and built in help messages.
+
+## API Reference
+
+### command
+
+__command(name, description, define)__
+
+- name: A string. The name of your command
+- description: A string. A short description. Optional
+- [define](#define): A function to define your command
+
+### define
+
+__define({[option, parameter, command})__
+
+- [option](#option)
+- [parameter](#parameter)
+- [command](#command)
+
+It should return a function to call when the command is run. See [action](#action)
+
+### option
+
+__option(key, definition)__
+
+- key: The name of the option
+- [definition](#definition): An object that defines your option
+
+### parameter
+
+__parameter(key, definition)__
+
+- key: The name of the parameter
+- [definition](#definition): An object that defines your parameter
+
+### action
+
+__action(args)__
+
+It's passed args which are all the options and parameters when run.
+
+### definition
+
+__{aliases, default, description, multiple, required, type}__
+
+- aliases: Optional. An array of strings, each an alias.
+- default: Optional. The default value if none is given.
+- description: A short description
+- multiple: Optional. A boolean. If true then multiple values are accepted.
+- required: Optional. A boolean. If true it is required.
+- type: A function like Boolean or Number. The value is passed to it to cast it to that type.

No alert changes

Improved metrics

Total package byte prevSize

23461

increased by5.74%

Number of lines in readme file

55

increased by1275%

No dependency changes