initial commit

README.md

@@ -1,2 +1,28 @@
 # plurify
-Library to pluralize words
+
+![Build](https://github.com/YGGverse/plurify/actions/workflows/build.yml/badge.svg)
+
+Pluralize words in different locales
+
+## Install
+
+``` bash
+cargo add plurify
+```
+
+## Usage
+
+``` rust
+use plurify::ns;
+
+let en = &["cat", "cats", "cats"];
+let uk = &["кіт", "кота", "котів"];
+
+assert_eq!(ns(1, en), "cat");
+assert_eq!(ns(2, en), "cats");
+assert_eq!(ns(5, en), "cats");
+
+assert_eq!(ns(1, uk), "кіт");
+assert_eq!(ns(2, uk), "кота");
+assert_eq!(ns(5, uk), "котів");
+```