From 6a0d0f4fe0b2382269665457a7e857a3f11807c6 Mon Sep 17 00:00:00 2001 From: Cesar Ferreira Date: Sun, 4 Sep 2016 14:59:42 +0100 Subject: [PATCH] updated readme --- README.md | 36 +++++++++++++----------------------- 1 file changed, 13 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index cbdb0b4..cd8d9b9 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,30 @@ -# kotlin-pluralizer +# kotlin-pluralizer [![Build Status](https://travis-ci.org/cesarferreira/kotlin-pluralizer.svg?branch=master)](https://travis-ci.org/cesarferreira/kotlin-pluralizer) **kotlin extension** to **pluralize** and **singularize** strings! - -### Specs -[![Build Status](https://travis-ci.org/cesarferreira/kotlin-pluralizer.svg?branch=master)](https://travis-ci.org/cesarferreira/kotlin-pluralizer) - - - ### Show some :heart: -[![GitHub stars](https://img.shields.io/github/stars/cesarferreira/kotlin-pluralizer.svg?style=social&label=Star)](https://github.com/cesarferreira/kotlin-pluralizer) [![GitHub forks](https://img.shields.io/github/forks/cesarferreira/kotlin-pluralizer.svg?style=social&label=Fork)](https://github.com/cesarferreira/kotlin-pluralizer/fork) [![GitHub watchers](https://img.shields.io/github/watchers/cesarferreira/kotlin-pluralizer.svg?style=social&label=Watch)](https://github.com/cesarferreira/kkotlin-pluralizer) [![GitHub followers](https://img.shields.io/github/followers/cesarferreira.svg?style=social&label=Follow)](https://github.com/cesarferreira/kotlin-pluralizer) -[![Twitter Follow](https://img.shields.io/twitter/follow/cesarmcferreira.svg?style=social)](https://twitter.com/cesarmcferreira) - - - -Partikular -ksingle -specialK -specifik +[![GitHub followers](https://img.shields.io/github/followers/cesarferreira.svg?style=social&label=Follow)](https://github.com/cesarferreira/kotlin-pluralizer) [![Twitter Follow](https://img.shields.io/twitter/follow/cesarmcferreira.svg?style=social)](https://twitter.com/cesarmcferreira) ## Usage +**Pluralization:** + ```kotlin "person".pluralize() # => "people" "post".pluralize() # => "posts" -"octopus".pluralize() # => "octopi" "sheep".pluralize() # => "sheep" -"words".pluralize() # => "words" -"CamelOctopus".pluralize() # => "CamelOctopi" ``` +**Singuralization:** + +```kotlin +"words".singularize() # => "word" +"octopi".pluralize() # => "octopus" + +``` + + ## Install TODO