[0.4] ReadMe

README.md

@@ -1,40 +1,17 @@
 # NameCaseLib
-Библиотека PHP5 позволяет склонять по падежам Фамилии Имена и Отчества. Имеет две версии для украинского и русского языка. Для обеих языков работаю одинаковые функция для склонения.
-В скором времени ожидается версия 0.4 с оптимизацией кода и версия 0.5, когда будет написана детальная инструкция по использованию и создан багтрекер.
-## Туториал
-Пример для украинского и русского языка находится в папке Tutorial
+NameCaseLib — библиотека PHP5, предназначенная для автоматического склонения ФИО в русском и украинском языках. Уникальная особенность состоит в том, что библиотека содержит одинаковые методы для работы с ФИО на русском и украинском языках.
 
-Пример использования
------------
+## Инструкция
+- Демонстрация работы - http://namecaselib.com/case/
+- Документация - http://namecaselib.com/book/
 
-echo 'Отчет, ' .
- $nc->q("Афонин Николай Сергеевич", NCL::$RODITLN)
- . ' о проделаной работе вместе с его сыном ' .
- $nc->q("Афонин Никита", NCL::$TVORITELN) .
- ' на осенних каникулах. Задание держалось на ' .
- $nc->q("Маргаритта Николаевна", NCL::$PREDLOGN) .
- '; Поздравляем всех предчастных, в том числе и ' .
- $nc->q("Кардонский Серафим Ильич", NCL::$VINITELN) . ' и ' .
- $nc->q("Лобудская София Викторовна", NCL::$VINITELN) .
- '. Хотим передать поздравление также ' .
- $nc->q("Игнатьев Павел Викторович", NCL::$DATELN) . ' и ' .
- $nc->q("Сумарский Лев", NCL::$DATELN);
-
-
-Результат выполнения
------------
-Отчет, Афонина Николая Сергеевича о проделаной работе вместе с его сыном Афониным Никитой на осенних каникулах. Задание держалось на Маргаритте Николаевне; Поздравляем всех предчастных, в том числе и Кардонского Серафима Ильича и Лобудскую Софию Викторовну. Хотим передать поздравление также Игнатьеву Павлу Викторовичу и Сумарскому Льву
-Документация
------------
-Полная документация находится в разработке.
-Дополнительные демонстрации находятся в папке Tutorial
-
-Лицензия
------------
-Dual licensed under the MIT or GPL Version 2 licenses.
-
-## 0.4 DEV
-- Рефакторинг кода
+## 0.4 (2011-07-09)
+- Полная переработка кода
+- Создание для каждого слова класса NCLNameCaseWord
+- Правила для склонения имен и фамилий объединены
+- Множество исправлений правил
+- Полная переработка ядра системы
+- Добавлена поддержка работы с разными регистрами слов
 
 ## 0.3 (2011-07-02)
 - Добавлен украинский язык
@@ -47,7 +24,7 @@ Dual licensed under the MIT or GPL Version 2 licenses.
 - Добавлена функция быстрого склонения NCLNameCaseRu::q(), которая принимает обязательный параметр ФИО в любом формате и возвращает строку в нужно падеже.
 
 ## 0.1.1 (2011-05-03)
-- Написана функция определения пола NCLNameCaseRu::GenderAutoDetect() — отлично справляется с парами Имя Фамилия, по моим тестам дает 100% прохождение тестов (2000 пар имен и фамилий). Если указано отчество, пол определает без проблем.Для просто имен вероятность правильного определения больше 98,5%. Для просто фамилий — больше 96%.
+- Написана функция определения пола NCLNameCaseRu::GenderAutoDetect() — отлично справляется с парами Имя Фамилия, по моим тестам дает 100% прохождение тестов (2000 пар имен и фамилий). Если указано отчество, пол определяет без проблем. Для просто имен вероятность правильного определения больше 98,5%. Для просто фамилий — больше 96%.
 
 ## 0.1.0 (2011-05-01)
-- Первая версия библиотеки
+- Первая версия библиотеки