chore: add usage

zentered · Dec 25, 2023 · a22cfdf · a22cfdf
1 parent 7c4605d
commit a22cfdf
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,20 @@
 # read-fixtures
+
 Tiny helper function to read JSON fixtures for tests
+
+```bash
+npm install @zentered/read-fixtures
+```
+
+## Usage
+
+```js
+import { test, mock } from 'node:test'
+import assert from 'node:assert/strict'
+import readFixture from '@zentered/read-fixtures'
+
+test('process events', async () => {
+  const mockData = await readFixture('log_stream.json')
+  ...
+})
+```