Update readme

Author: ije

README.md

@@ -1,28 +1,26 @@
 # esm-cjs-lexer
 
-A **WASM** module to parse the `module.exports` of a commonjs module, powered by [swc](https://github.com/swc-project/swc).
+A commonjs module lexer written in Rust for detecting the `module.exports` of a commonjs module. The lexer is powered by [swc](https://github.com/swc-project/swc), compiled to WebAssembly.
 
-## Installation
+## Usage
 
-esm-cjs-lexer only supports node.js environment currently. You can install it via `npm`:
+esm-cjs-lexer currently only supports Node.js environment. You can install it via npm CLI:
 
 ```bash
 npm i esm-cjs-lexer
 ```
 
-## Usage
-
-esm-cjs-lexer provides a `parse` function that lookups the `module.exports` of a commonjs module by parsing the given code. The function returns an object with two properties: `exports` and `reexports`. The `exports` property is an array of the exported names, and the `reexports` property is an array of the reexported modules.
+esm-cjs-lexer provides a `parse` function that detects the `module.exports` of a commonjs module. The function returns an object with two properties: `exports` and `reexports`. The `exports` property is an array of the exported names, and the `reexports` property is an array of the reexported modules.
 
 ```js
 const { parse } = require("esm-cjs-lexer");
 
-// named exports
+// named exports by assignment
 // exports: ["a", "b", "c", "__esModule", "foo"]
 const { exports } = parse("index.cjs", `
   exports.a = "a";
   module.exports.b = "b";
-  Object.defineProperty(exports, "c", { value: "c" });
+  Object.defineProperty(exports, "c", { value: 1 });
   Object.defineProperty(module.exports, "__esModule", { value: true })
   const key = "foo"
   Object.defineProperty(exports, key, { value: "e" });
@@ -34,7 +32,7 @@ const { reexports } = parse("index.cjs", `
   module.exports = require("./lib");
 `);
 
-// object exports(spread supported)
+// object exports(spread syntax supported)
 // exports: ["foo", "baz"]
 // reexports: ["./lib"]
 const { exports, reexports } = parse("index.cjs", `
@@ -43,7 +41,7 @@ const { exports, reexports } = parse("index.cjs", `
   module.exports = { foo, ...obj, ...require("./lib") };
 `);
 
-// if condition
+// if expression
 // exports: ["foo", "cjs"]
 const { exports } = parse("index.cjs", `
   module.exports.a = "a";
@@ -57,11 +55,11 @@ const { exports } = parse("index.cjs", `
     exports.esm = true;
   }
   if (false) {
-    exports.ignore = "ignore";
+    exports.unreachable = true;
   }
 `);
 
-// if condition by checking `process.env.NODE_ENV`
+// condition exports by checking if `process.env.NODE_ENV` equals to `nodeEnv` option
 // reexports: ["./index.development.js"]
 const { reexports } = parse("index.cjs", `
   if (process.env.NODE_ENV === "development") {
@@ -74,26 +72,38 @@ const { reexports } = parse("index.cjs", `
 // block&IIFE
 // exports: ["foo", "baz", "__esModule"]
 const { exports } = parse("index.cjs", `
+  {
+    exports.foo = 'bar'
+  }
   (function () {
-    exports.foo = "bar"
+    exports.baz = 'qux'
     if (true) {
       return
     }
-    exports.ignore = "-"
+    exports.unreachable = true
   })();
-  {
-    exports.baz = 123
-  }
   exports.__esModule = true
 `);
 
-// function called exports
+// UMD format
+// exports: ["foo"]
+const { exports } = parse("index.cjs", `
+  (function (global, factory) {
+    typeof exports === "object" && typeof module !== "undefined" ? factory(exports) :
+    typeof define === "function" && define.amd ? define(["exports"], factory) :
+    (factory((global.MMDParser = global.MMDParser || {})));
+  }(this, function (exports) {
+    exports.foo = "bar";
+  }))
+`);
+
+// exports by calling a function
 // exports: ["foo"]
 const { exports } = parse("index.cjs", `
-  function Fn() {
+  function module() {
     return { foo: "bar" }
   }
-  module.exports = Fn()
+  module.exports = module()
 `);
 
 // annotated export names for ESM import
@@ -105,25 +115,12 @@ const { exports } = parse("lib.cjs", `
 })
 `);
 
-// UMD format
-// exports: ["foo"]
-const { exports } = parse("index.cjs", `
-  (function (global, factory) {
-    typeof exports === "object" && typeof module !== "undefined" ? factory(exports) :
-    typeof define === "function" && define.amd ? define(["exports"], factory) :
-    (factory((global.MMDParser = global.MMDParser || {})));
-  }(this, function (exports) {
-    exports.foo = "bar";
-  }))
-`);
-
-// function reexports
+// call reexports
 // reexports: ["./lib()"]
 const { reexports } = parse("index.cjs", `
   module.exports = require("./lib")()
 `);
-
-// apply function exports (call mode)
+// apply call reexports
 // exports: ["foo"]
 const { exports } = parse("lib.cjs", `
   module.exports = function() {