Skip to content

Commit 94af4af

Browse files
committed
docs(writing-adapters): Add install to adapter utils section
1 parent 7e37870 commit 94af4af

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/writing-adapters.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ your in luck. We have a set of utils that are well tested which handles filterin
5252
would like to use or skip to the next section. Keep in mind that you might not need all of these
5353
depending on the database you are using.
5454

55+
### Installation
56+
57+
```
58+
npm install micro-analytics-adapter-utils
59+
```
60+
5561
### `createKeyRegex`
5662
Creates a regex from a wildcard string, e.g. `/p*th`.
5763

@@ -83,11 +89,13 @@ Usage: `filterViews(views: Array<View>, options: { before: number, after: number
8389
## Tests
8490

8591
There is pre-written tests for adapters that you can use to make sure you adapter is implemented
86-
correctly. These can be easily used by adding jest and micro-analytics-cli as a dev dependency to your adapter(e.g. `npm install --save-dev micro-analytics-cli jest`). Then create a test file like the one below.
92+
correctly. These can be easily used by adding jest and micro-analytics-adapter-utils as a dev dependency
93+
to your adapter(e.g. `npm install --save-dev micro-analytics-adapter-utils jest`).
94+
Then create a test file like the one below.
8795

8896
```js
8997
// adapter.test.js
90-
const test = require('micro-analytics-cli/adapter-tests/unit-tests')
98+
const test = require('micro-analytics-adapter-utils/unit-tests')
9199

92100
test({
93101
name: 'adapter-name',

0 commit comments

Comments
 (0)