docs: improved clarity around installation and examples

mhweiner · Jun 26, 2024 · bd74dde · bd74dde
1 parent 20ccad4
commit bd74dde
Show file tree

Hide file tree

Showing 13 changed files with 6 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -39,8 +39,6 @@ Named after [Sir Tony Hoare](https://en.wikipedia.org/wiki/Tony_Hoare), the inve
   - Async/Await/Promise Support
   - Simple API facilitates functional programming patterns and AI test generation.
 
-[Read more on the inspiration, philosophy and attributions.](#inspiration-philosophy--attribution)
-
 # Table of Contents
 
 - [Examples](#examples)
@@ -72,7 +70,10 @@ test('should return "hello, world"', (assert) => {
   assert.equal(helloworld(), 'hello, world');
 });
 ```
-## Valid Word
+
+## Mocking Dependencies
+
+You can use [cjs-mock](https://npmjs.org/cjs-mock) to mock dependencies (only works with CommonJS modules). This is especially useful for mocking file system operations, network requests, or other side effects.
 
 _isValidWord.ts_
 ```typescript
@@ -110,7 +111,7 @@ test('invalid word returns false', async (assert) => {
 });
 ```
 
-See [demo](demo) or [src](src) directories for more examples.
+### For more examples, see [examples](examples) or [src](src).
 
 # Installation & Setup
 

diff --git a/demo/greet.spec.ts → examples/greet.spec.ts b/demo/greet.spec.ts → examples/greet.spec.ts
diff --git a/demo/greet.ts → examples/greet.ts b/demo/greet.ts → examples/greet.ts
diff --git a/demo/helloworld-js.js → examples/helloworld-js.js b/demo/helloworld-js.js → examples/helloworld-js.js
diff --git a/demo/helloworld-js.spec.js → examples/helloworld-js.spec.js b/demo/helloworld-js.spec.js → examples/helloworld-js.spec.js
diff --git a/demo/helloworld.spec.ts → examples/helloworld.spec.ts b/demo/helloworld.spec.ts → examples/helloworld.spec.ts
diff --git a/demo/helloworld.ts → examples/helloworld.ts b/demo/helloworld.ts → examples/helloworld.ts
diff --git a/demo/isValidWord.spec.ts → examples/isValidWord.spec.ts b/demo/isValidWord.spec.ts → examples/isValidWord.spec.ts
diff --git a/demo/isValidWord.ts → examples/isValidWord.ts b/demo/isValidWord.ts → examples/isValidWord.ts
diff --git a/demo/validate.spec.ts → examples/validate.spec.ts b/demo/validate.spec.ts → examples/validate.spec.ts
diff --git a/demo/validate.ts → examples/validate.ts b/demo/validate.ts → examples/validate.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -21,7 +21,7 @@
     "url": "https://github.com/mhweiner/hoare.git"
   },
   "scripts": {
-    "test": "npm run build && c8 ./bin/cli.js '@(demo|src)/**/*.spec.@(ts|js)' && c8 report -r text -r html",
+    "test": "npm run build && c8 ./bin/cli.js '@(examples|src)/**/*.spec.@(ts|js)' && c8 report -r text -r html",
     "lint": "eslint ./ --ext .js,.ts",
     "build": "rm -rf ./dist && tsc",
     "semantic-release": "semantic-release"
@@ -55,7 +55,6 @@
     "c8": "^7.10.0",
     "cjs-mock": "^0.1.0",
     "eslint": "^8.1.0",
-    "hoare": "^2.0.6",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.2"
   }