Рефакторинг

- Рефакторинг.
- Переработано API.
- Уменьшен размер словарей.

.jscsrc

@@ -14,8 +14,7 @@
         "src/end.js"
     ],
     "requireCurlyBraces": ["if", "else", "for", "while", "do"],
-    "requireSpaceAfterKeywords": ["do", "else"],
-    "disallowSpaceAfterKeywords": ["if", "for", "while", "switch"],
+    "requireSpaceAfterKeywords": ["if", "for", "while", "switch", "do", "else"],
     "disallowSpacesInFunctionExpression": {
         "beforeOpeningRoundBrace": true
     },

.jshintrc

@@ -1,5 +1,6 @@
 {
     "predef": ["it", "describe"],
+	"esversion": 6,
     "browser": true,
     "mocha": true,
     "jquery": true,

.travis.yml

@@ -1,7 +1,11 @@
 language: node_js
 node_js:
-  - 0.12
-  - stable
+  - 4
+  - 6
+  - 7
+  - 8
+
+sudo: false
 
 after_success:
   - npm i coveralls

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v2.0.0
+__API v2 не совместимо с v1__.
+
+- В API появилась возможность создавать и изменять собственные словари.
+- Удалена поддержка старых версий Node.js.
+- Уменьшен размер и формат встроенных словарей.
+
 ## v1.0.7
 Исправлена ошибка в расстановке буквы «ё» в двухбуквенных словах. @nickkolok #4
 

README.md

@@ -17,62 +17,52 @@
 + аббревиатуры не обрабатываются.
 
 ## Установка
-`npm install eyo-kernel --save`
+`npm install eyo-kernel`
 
 ## Зависимости
 Отсутствуют.
 
 ## Использование
 ```
-var eyo = require('eyo-kernel');
-```
+const Eyo = require('eyo-kernel');
+const text = 'Мой текст...';
 
-## Методы
-### .restore(text)
-Безопасно восстанавливает букву «ё» в тексте.<br/>
-`text {string}` – текст. Обязательный аргумент.<br/>
-Возвращаемое значение: `{string}`.
-```js
-console.log(eyo.restore('Все лед')); // Все лёд.
-```
+// Работа с безопасным встроенным словарём.
+const safeEyo = new Eyo();
+safeEyo.loadSafeSync(); // ./dict/safe.txt
+console.log('restore', safeEyo.restore(text));
+console.log('lint', safeEyo.lint(text));
+
+// Работа с небезопасным встроенным словарём.
+const notSafeEyo = new Eyo();
+notSafeEyo.loadNotSafeSync(); // ./dict/not_safe.txt
+console.log('restore', notSafeEyo.restore(text));
+console.log('lint', notSafeEyo.lint(text));
 
-### .lint(text, [needSort])
-Поиск вариантов безопасной и небезопасной замены «ё».<br/>
-`text {string}` – текст. Обязательный аргумент.<br/>
-`needSort {boolean}` – Сортивать ли полученные варианты замены. Необязательный аргумент.<br/>
-Возвращаемое значение: `{Object}`.
-```js
-console.log(eyo.lint('Все лед.'));
-/* {
-  safe: [
-    {
-      before: 'Лед',
-      after: 'Лёд',
-      count: 1,
-      position: [
-        {
-          line: 1,
-          column: 5
-        }
-      ]
-    }
-  ]
-  notSafe: [
-    {
-      before: 'Все',
-      after: 'Всё',
-      count: 1,
-      position: [
-        {
-          line: 1,
-          column: 1
-        }
-      ]
-    }
-  ] 
-} */
+// Загрузка собственного словаря.
+const eyo = new Eyo();
+eyo.loadSync('./my_eyo_dict.txt');
+console.log('restore', eyo.restore(text));
+console.log('lint', eyo.lint(text));
+
+// Создание собственного словаря.
+const eyo = new Eyo();
+// Добавить слово в свой словарь.
+eyo.addWord('словоСБуквойЁ');
+//...
+// Удалить слово из словаря.
+eyo.removeWord('словоСБуквойЁ');
+//...
+// Очистить словарь.
+eyo.clear();
 ```
 
+## Словарь
+Это текстовый файл с кодировкой UTF-8, каждое слово на отдельной строке.  
+Слова в словаре чувствительны к регистру букв. Слова, начинающиеся со строчной буквы, заменят в тексте слова со строчной и заглавной букв (Еж → Ёж и еж → ёж).  
+А слова, начинающиеся с заглавной буквы, заменят в тексте слова только с заглавной буквы (Еж → Ёж).
+
+
 ## [Консольная утилита](https://github.com/hcodes/eyo)
 
 ## Eyo в Yaspeller