erik/kotlin-pluralizer
erik/kotlin-pluralizer
1
0
Fork 0
mirror of https://github.com/ethauvin/kotlin-pluralizer.git synced 2025-04-25 00:37:12 -07:00
Code Releases Activity

updated readme

Browse source
This commit is contained in:
Cesar Ferreira 2016-09-04 13:15:32 +01:00
parent 83d03a4d23
commit ffdc586049
1 changed files with 15 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,19 +1,20 @@
<!-- ![Image](extras/logo.png) -->
# Kotlin-pluralizer
**Kotlin extension** to **pluralize** and **singularize** strings!
### Specs
[![Build Status](https://travis-ci.org/cesarferreira/dryrun.svg?branch=master)](https://travis-ci.org/cesarferreira/dryrun)
[![Build Status](https://travis-ci.org/cesarferreira/kKotlin-pluralizer.svg?branch=master)](https://travis-ci.org/cesarferreira/Kotlin-pluralizer)
<!--
### Featured in
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-dryrun-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/2361)
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Kotlin-pluralizer-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/2361)
[![Android Weekly](https://img.shields.io/badge/Android%20Weekly-%23200-blue.svg)](http://androidweekly.net/issues/issue-200)
-->
### Show some :heart:
[![GitHub stars](https://img.shields.io/github/stars/cesarferreira/dryrun.svg?style=social&label=Star)](https://github.com/cesarferreira/dryrun) [![GitHub forks](https://img.shields.io/github/forks/cesarferreira/dryrun.svg?style=social&label=Fork)](https://github.com/cesarferreira/dryrun/fork) [![GitHub watchers](https://img.shields.io/github/watchers/cesarferreira/dryrun.svg?style=social&label=Watch)](https://github.com/cesarferreira/dryrun) [![GitHub followers](https://img.shields.io/github/followers/cesarferreira.svg?style=social&label=Follow)](https://github.com/cesarferreira/dryrun)
[![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)
@ -38,6 +39,17 @@ specifik
TODO
## 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:
1. Match coding style (braces, spacing, etc.) This is best achieved using `CMD`+`Option`+`L` (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
2. If its a feature, bugfix, or anything please only change code to what you specify.
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
4. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.
5. Check for existing [issues](https://github.com/cesarferreira/kotKotlin-pluralizer/issues) first, before filing an issue.
6. Have fun!
## Credits
The pluralize and singularize methods are based on the code found in the following places.
@ -47,14 +59,5 @@ The pluralize and singularize methods are based on the code found in the followi
- https://github.com/rails/rails/blob/26698fb91d88dca0f860adcb80528d8d3f0f6285/activesupport/lib/active_support/inflector/inflections.rb
## 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:
1. Match coding style (braces, spacing, etc.) This is best achieved using `CMD`+`Option`+`L` (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
2. If its a feature, bugfix, or anything please only change code to what you specify.
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
4. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.
5. Check for existing [issues](https://github.com/cesarferreira/dryrun/issues) first, before filing an issue.
6. Have fun!
### Created & Maintained By
[Cesar Ferreira](https://github.com/cesarferreira) ([@cesarmcferreira](https://www.twitter.com/cesarmcferreira))