Skip to content

Commit 74a4942

Browse files
committed
docs: Add readme in adapter-utils
Fixes #74
1 parent 94af4af commit 74a4942

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

packages/adapter-utils/readme.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# `micro-analytics-adapter-utils` 🔧
2+
3+
A set of utilities and tests for creating database adapters.
4+
5+
## Installation
6+
7+
Running your own `micro-analytics` is just two tiny commands away:
8+
9+
```
10+
npm install micro-analytics-adapter-utils
11+
```
12+
13+
## Usage
14+
15+
Detailed information on the usage of the utilities and tests can be found in [writing adapters guide][]
16+
17+
```js
18+
const utils = require('micro-analytics-adapter-utils')
19+
```
20+
21+
#### Tests
22+
23+
There is a complete test suite for adapters in this module. Usage example below, complete lists
24+
of options is in [writing adapters guide][].
25+
26+
```js
27+
// adapter.test.js
28+
const test = require('micro-analytics-adapter-utils/unit-tests')
29+
30+
test({
31+
name: 'adapter-name',
32+
modulePath: path.resolve(__dirname, './index.js'),
33+
})
34+
```
35+
36+
## License
37+
38+
Copyright ©️ 2017 Maximilian Stoiber & Rolf Erik Lekang, licensed under the MIT License. See [`license.md`](./license.md) for more information.
39+
40+
[writing adapters guide]: https://github.com/micro-analytics/micro-analytics-cli/blob/master/docs/writing-adapters.md

0 commit comments

Comments
 (0)