apg-js-examples - npm Package Compare versions

Comparing version 4.0.2 to 4.0.3

package.json

 {
   "name": "apg-js-examples",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "Examples of using the suite of apg-js applications and libraries.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -5,20 +5,26 @@ # apg-js-examples
 
-Use the normal installation procedure. For example, to install locally in the current directory,
+**npm**
 
 ```
-npm init
-npm install apg-js-examples --save
+mkdir node_modules
+npm install apg-js-examples
 cd node_modules/apg-js-examples
-npm run
 ```
 
-Note that `npm run` will display a list of all the example scripts.
+**GitHub**
 
+```
+mkdir node_modules
+cd node_modules
+git clone https://github.com/ldthomas/apg-js.git
+git clone https://github.com/ldthomas/apg-js-examples.git
+cd apg-js-examples
+```
+
 ## Description
 
-This package contains a large set of examples of using apg-js,
+This package contains a large set of examples of using `apg-js`,
 the JavaScript version of APG, an ABNF Parser Generator.
-
 Each example is in its own directory and in that directory is
-a script, "main.sh", which will execute the example. Many examples
+a script, `main.sh`, which will execute the example. Many examples
 have multiple options. In these cases, running the script with
@@ -28,10 +34,15 @@ no arguments will display a desciption of the example and a
 
-npm scripts are available for each of these examples.
-See "package.json" for a list of available scripts.
-The examples can be run with "npm run \<example\>" or by executing
-the example scripts directly.
+npm scripts are also available for each of these examples
+in `package.json`. For example,
 
+```
+src/ast/main.sh
+&
+npm run ast
+```
+
+both run the AST test.
+
 If executing the scripts directly or in with a debugger, they should be
 excuted from the repository directory for correct relative path name alignment.
-That is, "./src/apg-lib/main.sh" is equivalent to "npm run apg-lib".
 
@@ -38,0 +49,0 @@ Each of the four libraries, apg-conv-api, apg-lib, apg-api and apg-exp,

src/udt/main.js

@@ -23,6 +23,6 @@ /*  *************************************************************************************
     help += "Usage: npm run udt [-- arg]\n";
-    help += "  arg: help (or no arg) to display this help screen.\n";
-    help += "       minimal \n";
-    help += "       stats \n";
-    help += "       trace \n";
+    help += "  arg: help    (or no arg) to display this help screen.\n";
+    help += "       minimal minimal procedures for setting up a parser for a grammar with UDTs\n";
+    help += "       stats   minimal with statistics generated\n";
+    help += "       trace   minimal with trace generated\n";
     if (!args[0]) {
@@ -29,0 +29,0 @@ /* display the help screen and exit */

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

406419

increased by0.2%

Number of lines in readme file

51

increased by27.5%

No dependency changes