Skip to content

Commit

Permalink
Add documentation (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikhailsidorov committed Sep 6, 2019
1 parent 89647f5 commit b1bd2f2
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
# nuxt-rambler-top100
# Nuxt Rambler Top-100

This plugin automatically sends first page and route change events to Rambler Top-100.

**Note:** module is not enabled in dev mode.
You can set environment variable `NODE_ENV` to `production` for testing in dev mode.

## Setup

`npm install --save nuxt-rambler-top100`

Add `nuxt-rambler-top100` to `modules` section of `nuxt.config.js`

```js
{
modules: [
[
'nuxt-rambler-top100',
{
// Project ID. Required parameter.
id: 'XXXXXX',

// Data attributes. Optional parameter.
attributesDataset: ['attribute1', 'attribute2']
}
]
]
}
```

For more information please read the documentation:

- [Rambler Top-100 documetation](https://doc.top100.rambler.ru/)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nuxt-rambler-top100",
"version": "0.0.1",
"version": "0.0.2",
"description": "Nuxt plugin for Rambler Top-100 service",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit b1bd2f2

Please sign in to comment.