Рабочая версия

readme.md

@@ -1,5 +1,3 @@
-## WIP
-
 ## turbo-rss
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/6525d2aabf20185b68b6/maintainability)](https://codeclimate.com/github/LightAir/turbo-rss/maintainability)
@@ -8,9 +6,7 @@
 [![npm](https://img.shields.io/badge/npm%20package-1.0.7-blue.svg?longCache=true&style=flat)](https://www.npmjs.com/package/turbo-rss)
 ![license](https://img.shields.io/packagist/l/doctrine/orm.svg?longCache=true&style=flat)
 
->Генератор RSS разметки для сервиса Турбо-страницы
-
->ПРЕДУПРЕЖДЕНИЕ! Работа в процессе
+>Генератор RSS разметки для сервиса Турбо-страницы https://yandex.ru/support/webmaster/turbo/connection.html
 
 ### Использование
 
@@ -25,12 +21,11 @@ var feed = new TR(feedOptions);
 ##### `Опции канала`
 
  * `title` **string** Название RSS-канала.
- * `description` _optional_ **string** Описание канала одним предложением. Не используйте HTML-разметку..
- * `author` _optional_  **string**  If included it is the name of the item's creator. **(Будет удалено)**
- * `link` **url string** Домен сайта, данные которого транслируются..
- * `pubDate` _optional_ **Date object or date string** The publication date for content in the feed **(Будет удалено)**
+ * `link` **url string** Домен сайта, данные которого транслируются.
+ * `description` _optional_ **string** Описание канала одним предложением. Не используйте HTML-разметку.
+ * `language` _optional_ **string** Язык статьи по стандарту ISO 639-1. По умолчанию ru.
  
- *Будет добавлено в новых версиях turbo:analytics, turbo:adNetwork*
+ *Будет добавлено в новых версиях turbo:analytics, turbo:adNetwork, на текущий момент можно добавить в интерфейсе Яндекс Вебмастер*
  
 #### Добавление страницы в канал
 ```js
@@ -40,22 +35,29 @@ feed.item(itemOptions);
 ##### itemOptions
 
  * `title` **string** Заголовок страницы.
- * `image_url` **url string** Адрес изображения, которое используется в качестве обложки. Изображение может быть в любом формате.
- * `url` **url string** URL страницы сайта, для которой нужно сформировать Турбо-страницу.
+ * `image_url` _optional_ **url string** Адрес изображения, которое используется в качестве обложки. Изображение может быть в любом формате.
+ * `link` **url string** URL страницы сайта, для которой нужно сформировать Турбо-страницу.
  * `author` _optional_  **string**  Автор статьи, размещенной на странице.
- * `date` **string** Время публикации контента на сайте источника.
+ * `date` или `pubDate` **string** Время публикации контента на сайте источника. Передается в формате RFC-822.
  * `content` **string** Содержимое страницы
- * `related` _optional_ **array** Аффилированные ссылки `yandex:related` в конце статьи.
+ * `menu` _optional_ **array** Внимание! Меню будет отображаться только в том случае, если в настройках на странице Яндекс Вебмастер -> Турбо-страницы -> Настройки, содержимое 'Меню Турбо-страниц' пустое!
+ * `related` _optional_ **array** Аффилированные ссылки `yandex:related` в конце статьи. Вы можете разместить ссылки на другие ресурсы или настроить отображение непрерывной ленты статей, реализованной, например с помощью AJAX.
  * `relatedfinity` _optional_  **bool** Непрерывная лента статей
- 
- *Будет добавлено в новых версиях turbo:source, turbo:topic, menu, pubDate как алиас date*
+ * `turboSource` _optional_ **string** URL страницы-источника, который можно передать в Яндекс.Метрику.
+ * `turboTopic` _optional_ **string** Заголовок страницы, который можно передать в Яндекс.Метрику.
+
+###### menu array
+  menu должен содержать массив объектов со следующими опциями:
+  
+  * `link` **url string** ссылка
+  * `text` **string** текст ссылки. не должен содержать html
  
 ###### related array
   related должен содержать массив объектов со следующими опциями:
   
-  * `link` **string** ссылка на статью'
-  * `image_url` **string** ссылка на изображение к статье
-  * `text` **string** текст ссылки
+  * `link` **url string** ссылка на статью
+  * `image_url` **url string** ссылка на изображение к статье
+  * `text` **string** текст ссылки. Не должен содержать html
  
 ##### Получение XML
 
@@ -69,14 +71,12 @@ var xml = feed.xml();
 ```js
 var TR = require('turbo-rss');
 
-/* lets create feed */
 var feed = new TR({
     title: 'title',
     description: 'description',
     link: 'http://example.com',
 });
 
-/* loop over data and add to feed */
 feed.item({
     title:  'item title',
     image_url: 'http://example.com/example.png',
@@ -84,6 +84,13 @@ feed.item({
     author: 'LightAir',
     date: 'May 27, 2012',
     content: '<p>hello</p>',
+    menu: [{
+          link: 'http://example.com/',
+          text: 'Главная'
+        }, {
+          link: 'http://example.com/about',
+          text: 'О сайте'
+        }]
     related: [{
       link: 'http://example.com/related/post1',
       image_url: 'http://example.com/i/img1.jpg',
@@ -95,13 +102,12 @@ feed.item({
     }]
 });
 
-// cache the xml to send to clients
 var xml = feed.xml();
 ```
 
 ## Тестирование
 
-Для запуска тестов выполните `npm test`. На текущий момен покрытие тестами не 100%
+Для запуска тестов выполните `npm test`.
 
 ```sh
 $ npm test