Skip to content

Commit b1bd2f2

Browse files
Add documentation (#3)
1 parent 89647f5 commit b1bd2f2

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,33 @@
1-
# nuxt-rambler-top100
1+
# Nuxt Rambler Top-100
2+
3+
This plugin automatically sends first page and route change events to Rambler Top-100.
4+
5+
**Note:** module is not enabled in dev mode.
6+
You can set environment variable `NODE_ENV` to `production` for testing in dev mode.
7+
8+
## Setup
9+
10+
`npm install --save nuxt-rambler-top100`
11+
12+
Add `nuxt-rambler-top100` to `modules` section of `nuxt.config.js`
13+
14+
```js
15+
{
16+
modules: [
17+
[
18+
'nuxt-rambler-top100',
19+
{
20+
// Project ID. Required parameter.
21+
id: 'XXXXXX',
22+
23+
// Data attributes. Optional parameter.
24+
attributesDataset: ['attribute1', 'attribute2']
25+
}
26+
]
27+
]
28+
}
29+
```
30+
31+
For more information please read the documentation:
32+
33+
- [Rambler Top-100 documetation](https://doc.top100.rambler.ru/)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "nuxt-rambler-top100",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"description": "Nuxt plugin for Rambler Top-100 service",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)