From e579f7bfe16eec2d3abeb56e5e9e305c504d7202 Mon Sep 17 00:00:00 2001 From: Cesar Ferreira Date: Sat, 10 Sep 2016 12:43:42 +0100 Subject: [PATCH] updated readme --- README.md | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 7c41a94..51eb799 100644 --- a/README.md +++ b/README.md @@ -3,43 +3,50 @@ **kotlin extension** to **pluralize** and **singularize** strings -[![Build Status](https://travis-ci.org/cesarferreira/kotlin-pluralizer.svg?branch=master)](https://travis-ci.org/cesarferreira/kotlin-pluralizer) [![Release](https://jitpack.io/v/cesarferreira/kotlin-pluralizer.svg)](https://jitpack.io/#cesarferreira/kkotlin-pluralizer) [ ![bintray](https://api.bintray.com/packages/cesarferreira/maven/kotlin-pluralizer/images/download.svg) ](https://bintray.com/cesarferreira/maven/kotlin-pluralizer/_latestVersion) +[![Build Status](https://travis-ci.org/cesarferreira/kotlin-pluralizer.svg?branch=master)](https://travis-ci.org/cesarferreira/kotlin-pluralizer) [![Release](https://jitpack.io/v/cesarferreira/kotlin-pluralizer.svg)](https://jitpack.io/#cesarferreira/kkotlin-pluralizer) + +### Show some love +[![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" -"sheep".pluralize() # => "sheep" -"foot".pluralize() # => "feet" +"person".pluralize() # => "people" +"post".pluralize() # => "posts" +"sheep".pluralize() # => "sheep" +"foot".pluralize() # => "feet" ``` **Singuralization:** ```kotlin -"words".singularize() # => "word" -"octopi".singularize() # => "octopus" -"people".singularize() # => "person" -"feet".singularize() # => "foot" +"words".singularize() # => "word" +"octopi".singularize() # => "octopus" +"people".singularize() # => "person" +"feet".singularize() # => "foot" +``` + +**Quantities:** +```kotlin +"person".pluralize(1) # => "person" +"person".pluralize(2) # => "people" ``` ## Install ```groovy repositories { - jcenter() - maven { url "https://jitpack.io" } + jcenter() + maven { url "https://jitpack.io" } } dependencies { - compile 'com.github.cesarferreira:kotlin-pluralizer:0.2.4' + compile 'com.github.cesarferreira:kotlin-pluralizer:0.2.6' } ``` -## Show some love -[![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) - ## Contributing I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request: