ascjs - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "ascjs",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "ES2015 to CommonJS import/export transformer",
@@ -5,0 +5,0 @@ "bin": "bin.js",

README.md

@@ -12,2 +12,39 @@ # ascjs
 
+## How to
+
+You can use _ascjs_ as binary utility or as module.
+
+```sh
+npm install -g ascjs
+
+# to see what you can do
+ascjs --help
+
+```
+
+As executable, you can use _ascjs_ to output, or save, some code content.
+```sh
+ascjs code
+ascjs sourceFile
+ascjs sourceFile destFile
+
+# folders are recursively parsed
+# destFolder is mandatory
+ascjs sourceFolder destFolder
+```
+
+You can also use it via pipe operator.
+```sh
+echo code | ascjs
+cat source.js | ascjs | uglifyjs -o dest.js
+```
+
+As module, you can require it and use it to convert ESM to CJS.
+```js
+const ascjs = require('ascjs');
+
+ascjs('import "test";');
+// require("test");
+```
+
 ### Features
@@ -14,0 +51,0 @@

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

11846

increased by5.62%

Number of lines in readme file

93

increased by66.07%

No dependency changes