From b1bd2f2f22e80e5cc97f84e65d35be184f80a961 Mon Sep 17 00:00:00 2001 From: Mikhail Sidorov <7780462+mikhailsidorov@users.noreply.github.com> Date: Fri, 6 Sep 2019 03:00:24 +0300 Subject: [PATCH] Add documentation (#3) --- README.md | 34 +++++++++++++++++++++++++++++++++- package.json | 2 +- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46b5925..748e3f1 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -# nuxt-rambler-top100 \ No newline at end of file +# 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/) diff --git a/package.json b/package.json index c831885..e4a1013 100644 --- a/package.json +++ b/package.json @@ -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": {