mockaton 9.1.1 → 9.2.0

package/README.md

@@ -94,9 +94,9 @@ api/videos.GET.<b>500</b>.txt   # Internal Server Error
 ## Scraping Mocks from your Backend
 
 ### Option 1: Browser Extension
-With the companion [browser-devtools
+The companion Chrome [devtools
 extension](https://github.com/ericfortis/download-http-requests-browser-ext)
-you can download all the HTTP responses, and they
+lets you download all the HTTP responses, and they
 get saved following Mockaton’s filename convention.
 
 ### Option 2: Fallback to Your Backend
@@ -123,7 +123,7 @@ They will be saved in your `config.mocksDir` following the filename convention.
 - Does not write to disk. Except when you select ✅ **Save Mocks** for scraping mocks from a backend.
 - Does not initiate network connections (no logs, no telemetry).
 - Does not hijack your HTTP client.
-- Auditable. Organized and small &mdash; under 4 KLoC (50% is UI and tests).
+- Auditable. Organized and small &mdash; under 4 KLoC (half is UI and tests).
 
 
 ## Basic Usage
@@ -131,21 +131,28 @@ They will be saved in your `config.mocksDir` following the filename convention.
 
 2. Create a sample mock in the default mocks directory (`./mockaton-mocks`)
 ```sh
-mkdir -p mockaton-mocks/api/
+mkdir -p         mockaton-mocks/api
 echo "[1,2,3]" > mockaton-mocks/api/foo.GET.200.json
 ```
-3. Run Mockaton (npx installs it if needed)
+3. Run Mockaton (`npx` installs it if needed)
 ```shell
 npx mockaton --port 2345
 ```
 
+4. Test it
+```shell
+curl http://localhost:2345/api/foo 
+```
+
+### Alternative Installations
 <details>
-<summary>Or, if you have a package.json</summary>
+<summary>With NPM…</summary>
 
 ```shell
 npm install mockaton --save-dev
 ```
 
+Then in your, `package.json`:
 ```json
 {
   "scripts": {
@@ -157,17 +164,19 @@ npm install mockaton --save-dev
 
 
 <details>
-<summary>Or, if want an executable without using NPM?</summary>
+<summary>Without NPM…</summary>
+
+Since Mockaton has no dependencies, you can create an executable
+by linking to `src/cli.js`.
 
-Clone this repo, and make a link to `src/cli.js`
 ```shell
 git clone https://github.com/ericfortis/mockaton.git
 ln -s `realpath mockaton/src/cli.js` ~/bin/mockaton # some dir in your $PATH
 ```
 
-
 </details>
 
+<br/>
 
 
 ## CLI Options
@@ -484,15 +493,17 @@ Defaults to `'normal'`.
 <details>
 <summary>Programmatic Launch (Optional)</summary>
 
+
 ```js
 import { Mockaton } from 'mockaton'
 import mockatonConfig from './mockaton.config.js'
 
-Mockaton({
+const server = Mockaton({
   ...mockatonConfig, // Not required, but it’s not read by default.
-  port: 3333, // etc.
 })
 ```
+See [src/cli.js](src/cli.js)
+
 </details>