ngn4-compiler - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "ngn4-compiler",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Sample compiler for ngn4",
@@ -5,0 +5,0 @@ "main": "index.js",

readme.md

@@ -21,7 +21,5 @@ #ngn4-compiler
 
-### Linux
-The easiest way to install it on a Linux system is `sudo npm install -g ngn4-compiler`. See `ngn4-compiler -h` command help. If it's not installed globally, use the `node` command on the directory of this module or its index.js with the `-d` parameter followed by a relative or absolute path to the sample library.
+The easiest way to install it is `sudo npm install -g ngn4-compiler`. See `ngn4-compiler -h` command help. If it's not installed globally, use the `node` command on the directory of this module or its index.js with the `-d` parameter followed by a relative or absolute path to the sample library.
 
-### Windows
-If you're regularly using Windows for node.js development, then I'm sure you'll have a better solution. If not, then get the package and its dependencies with npm, put node.js' executable in that folder, and you can run `node . -d path/to/library` when cd'd to that directory with cmd.
+Global installation should work in Windows if you installed node.js and npm with the Windows installer provided on the official website.
 
@@ -109,9 +107,17 @@ ## Usage: Standalone
 
-## ngn4-test
-If installed globally, there is an `ngn4-test` command that you can use. It loads sample files from a sub-folder with name matching the `id` field in the JSON file given as parameter, and generates a name with the results. There are also 3 optional parameters: amount, format and gender.
+## ngn4-test (global install only)
+There is an `ngn4-test` command that you can use. It loads sample files from a sub-folder with name matching the `id` field in the JSON file given as parameter, and generates a name with the results. There are also 3 optional parameters: amount, format and gender.
 
 Example: `ngn4-test mygenerator.json 16 full_name female`
 
+## ngn4-generate (global install only)
+To test the results of a compile, you can use the `ngn4-generate` command. It loads the full set from a JSON file and generates one or more names according to parameters. Providing no parameters after the JSON filename will give you a list of the set's contents.
+
+Example: `ngn4-test myset.json mycat/mygenerator 100 first_name male`
+
 ## Change Log
 ```
+0.2.1
+- Readme edits
+
 0.2.0
@@ -118,0 +124,0 @@ - The version info (-V/--version) now exits the program like it should.

No alert changes

Improved metrics

Total package byte prevSize

20734

increased by1%

Number of lines in readme file

129

increased by4.88%

No dependency changes