first commit

1 files changed, 18 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1653d95
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# vkflex-php
+
+Расширение для PHP для склонения имен. Использует vkext/flex из [KittenPHP](https://github.com/vk-com/kphp-kdb).
+Включена поддержка русского и украинского.
+
+### Использование
+
+`vkflex($name, $case, $sex, $lang, $type)`
+
+- `$name` - имя или фамилия в кодировке cp1251;
+- `$case` - падеж: `Gen`, `Dat`, `Acc`, `Ins` или `Abl`;
+- `$sex` - `0` - мужской, `1` - женский;
+- `$lang` - `0` - русский, `1` - украинский;
+- `$type` - `0` - имя, `1` - фамилия.
+
+Возвращает строку в кодировке cp1251.
+
+См. пример в `test.php`.