readme

README.md

@@ -1,40 +1,28 @@
-# NameCaseLib - Библиотека позволяет склонять по падежам Фамилию Имя Отчество.
-
+# NameCaseLib
+Библиотека для PHP5 позволяет склонять по падежам Фамилию Имя Отчество. Имеет очень хороший алгоритм склонения Имен, Отчеств и Фамилий. Это первая публичная версия библиотеки. Пожалуйста оставляйте все свои пожелания и замечания.
 ## Туториал
+Встроенные константы
+-----------
+* NCLNameCaseRu::$MAN - мужской пол
+* NCLNameCaseRu::$WOMAN - женский пол
 
-Tutorial/smallDemo.php
-<?php
-header('Content-type: text/html; charset=utf-8');
-/*
- * Небольшой пример использования библиотеки
- * 1. Шаг подключаем библиотеку
- */
-require '../Library/NCL.NameCase.ru.php';
-/*
- * 2. Создаем объект
- */
-$nc = new NCLNameCaseRu();
-/*
- * =========================
- * Встроенные константы
- * =========================
- * NCLNameCaseRu::$MAN - мужской пол
- * NCLNameCaseRu::$WOMAN - женский пол
- * 
- * NCLNameCaseRu::$IMENITLN - именительный падеж
- * NCLNameCaseRu::$RODITLN - родительные падеж
- * NCLNameCaseRu::$DATELN - дательные падеж
- * NCLNameCaseRu::$VINITELN - винительный падеж
- * NCLNameCaseRu::$TVORITELN - творительный падеж
- * NCLNameCaseRu::$PREDLOGN - предложный падеж
- * 
- * ========================
- * Описание формата вывода
- * ========================
- * S - фамилия
- * N - имя
- * F - отчество
- */
+* NCLNameCaseRu::$IMENITLN - именительный падеж
+* NCLNameCaseRu::$RODITLN - родительные падеж
+* NCLNameCaseRu::$DATELN - дательные падеж
+* NCLNameCaseRu::$VINITELN - винительный падеж
+* NCLNameCaseRu::$TVORITELN - творительный падеж
+* NCLNameCaseRu::$PREDLOGN - предложный падеж
+ 
+
+Описание формата вывода
+-----------
+* S - фамилия
+* N - имя
+* F - отчество
+
+
+Пример использования
+-----------
 
 echo 'Отчет, ' .
  $nc->qFullName("Афонин", "Николай", "Сергеевич", NCLNameCaseRu::$MAN, NCLNameCaseRu::$RODITLN)
@@ -49,14 +37,17 @@ echo 'Отчет, ' .
  $nc->qFullName("Игнатьев", "Павел", "Викторович", NCLNameCaseRu::$MAN, NCLNameCaseRu::$DATELN) . ' и ' .
  $nc->qFullName("Сумарский", "Лев", "", NCLNameCaseRu::$MAN, NCLNameCaseRu::$DATELN, "S N");
 
-/*
- * ========================
- * Результат выполнения
- * ========================
- * Отчет, Афонина Николая Сергеевича о проделаной работе вместе с его сыном Никитой Афониным на осенних каникулах. Задание держалось на Маргаритте Николаевне; Поздравляем всех предчастных, в том числе и Кардонского Серафима Ильича и Лобудскую Софию Викторовну. Хотим передать поздравление также Игнатьеву Павлу Викторовичу и Сумарскому Льву
- */
-?>
 
+Результат выполнения
+-----------
+Отчет, Афонина Николая Сергеевича о проделаной работе вместе с его сыном Никитой Афониным на осенних каникулах. Задание держалось на Маргаритте Николаевне; Поздравляем всех предчастных, в том числе и Кардонского Серафима Ильича и Лобудскую Софию Викторовну. Хотим передать поздравление также Игнатьеву Павлу Викторовичу и Сумарскому Льву
+Дополнительно
+-----------
+Дополнительные демонстрации находятся в папке Tutorial
+
+Лицензия
+-----------
+Dual licensed under the MIT or GPL Version 2 licenses.
 
 ## 0.1.0 (2011-05-01)
 - Первая версия библиотеки