argus - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
    "name":"argus",
    "description":"Complex CLI argument parser",
-   "version":"0.0.1",
+   "version":"0.0.2",
    "homepage":"http://github.com/wearefractal/argus",
@@ -6,0 +6,0 @@ "repository":"git://github.com/wearefractal/argus.git",

README.md

@@ -21,3 +21,3 @@ ![status](https://secure.travis-ci.org/wearefractal/argus.png?branch=master)
 
-Argus allows you to pass an array of complex data to your application through a CLI. This can be an array of objects, strings, numbers, you name it. Anything that is a valid JSON array can be used. Ideally when you get this array of objects you would pass it into whatever function was being called.
+Argus allows you to pass an array of complex data to your application through a CLI. This can be an array of objects, strings, numbers, you name it. Anything valid JSON array can be used.
 
@@ -27,3 +27,13 @@ ## Usage
 ```coffee-script
-mycli dostuff["johnny boy",true,-1]
+# You can pass an array of JSON values
+mycli dostuff["johnny boy",true,-1] # {"dostuff":["johnny boy",true,-1]}
+
+# You can set it to a single JSON value
+mycli dostuff=true # {"dostuff":true} 
+
+# You can mix single and multi-value commands
+mycli dostuff=true:otherstuff[true,2.05,"test"] # {"dostuff":true, "otherstuff":[true,2.05,"test"]}
+
+# Non-JSON arguments used with = will be turned into strings
+mycli dostuff=testlol # {"dostuff":"testlol"}
 ```
@@ -33,3 +43,3 @@
 
-Bash doesn't agree with a lot of characters so some escaping may be required. Still looking for a solution to this.
+Bash doesn't agree with a lot of JSON characters so some escaping may be required. Still looking for a solution to this.
 
@@ -36,0 +46,0 @@ ## LICENSE

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11990

increased by22.16%

Number of lines in readme file

67

increased by17.54%

Worsened metrics

Number of package files

10

decreased by-9.09%

No dependency changes