Skip to content

Commit 294d115

Browse files
committed
Update README
1 parent 6879cf9 commit 294d115

2 files changed

Lines changed: 30 additions & 23 deletions

File tree

README.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,13 @@ http.createServer(function (req, res) {
6767
* @param {string} [ut] - для запрета индексирования 'noindex'
6868
* @return {Object} this
6969
*
70-
* @example
71-
* counter.hit('http://mysite.org', 'Main page', 'http://google.com/...');
72-
*
73-
* // С запретом на индексирования и параметрами визитов
74-
* counter.hit('http://mysite.org', 'Main page', 'http://google.com/...', {level1: {level2: 1}}, 'noindex');
70+
* hit: function (pageUrl, pageTitle, pageRef, userParams, ut) {}
7571
*/
72+
73+
counter.hit('http://mysite.org', 'Main page', 'http://google.com/...');
74+
75+
// С запретом на индексирование и параметрами визитов
76+
counter.hit('http://mysite.org', 'Main page', 'http://google.com/...', {level1: {level2: 1}}, 'noindex');
7677
```
7778

7879
## Достижение цели
@@ -81,12 +82,13 @@ http.createServer(function (req, res) {
8182
* @param {string} target - название цели
8283
* @param {Object} [userParams] - параметры визитов
8384
*
84-
* @example
85-
* counter.reachGoal('goalName');
86-
*
87-
* // С параметрами визитов
88-
* counter.reachGoal('goalName', {level1: {level2: 1}});
85+
* reachGoal: function (target, userParams) {}
8986
*/
87+
88+
counter.reachGoal('goalName');
89+
90+
// С параметрами визитов
91+
counter.reachGoal('goalName', {level1: {level2: 1}});
9092
```
9193

9294
## Внешняя ссылка
@@ -96,9 +98,11 @@ http.createServer(function (req, res) {
9698
* @param {string} [title] - заголовок страницы
9799
* @return {Object} this
98100
*
101+
* extLink: function (url, title) {}
99102
* @example
100-
* counter.extLink('http://nodejs.org');
101103
*/
104+
105+
counter.extLink('http://nodejs.org');
102106
```
103107

104108
## Загрузка файла
@@ -108,9 +112,10 @@ http.createServer(function (req, res) {
108112
* @param {string} [title] - заголовок страницы
109113
* @return {Object} this
110114
*
111-
* @example
112-
* counter.file('http://mysite.org/secret.zip');
115+
* file: function (file, title) {}
113116
*/
117+
118+
counter.file('http://mysite.org/secret.zip');
114119
```
115120

116121
## Параметры визитов
@@ -119,19 +124,21 @@ http.createServer(function (req, res) {
119124
* @param {...*} параметры визитов
120125
* @return {Object} this
121126
*
122-
* @example
123-
* counter.params({level1: {level2: {level3: 1}}});
124-
* или
125-
* counter.params('level1', 'level2', 'level3', 1);
127+
* params: function (...) {}
126128
*/
129+
130+
counter.params({level1: {level2: {level3: 1}}});
131+
132+
// или
133+
counter.params('level1', 'level2', 'level3', 1);
127134
```
128135

129136
## Не отказ
130137
```JavaScript
131138
/**
132139
* @return {Object} this
133140
*
134-
* @example
135-
* counter.notBounce();
136-
*/
141+
*/
142+
143+
counter.notBounce();
137144
```

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
"url": "https://github.com/hcodes"
66
},
77
"name": "yametrika",
8-
"description": "",
9-
"version": "0.9.0",
8+
"description": "Серверное отслеживание посетителей с помощью Яндекс.Метрики",
9+
"version": "0.9.1",
1010
"homepage": "https://github.com/hcodes/server_yametrika_nodejs",
1111
"repository": {
1212
"type": "git",
1313
"url": "git@github.com:hcodes/server_yametrika_nodejs.git"
1414
},
1515
"keywords": [
16-
"yandex", "metrika", "analytics"
16+
"yandex", "metrika", "analytics", "stats", "metrics", "track"
1717
],
1818
"devDependencies": {},
1919
"optionalDependencies": {},

0 commit comments

Comments
 (0)