diff --git a/README.md b/README.md index a3a9fd4..45c7b26 100644 --- a/README.md +++ b/README.md @@ -3,26 +3,19 @@ Inflector Inflector pluralizes and singularizes English nouns. -**Documentation:** - [![Build Status](https://travis-ci.org/gedex/inflector.png?branch=master)](https://travis-ci.org/gedex/inflector) -[![Build Status](https://drone.io/github.com/gedex/inflector/status.png)](https://drone.io/github.com/gedex/inflector/latest) [![Coverage Status](https://coveralls.io/repos/gedex/inflector/badge.png?branch=master)](https://coveralls.io/r/gedex/inflector?branch=master) +[![GoDoc](https://godoc.org/github.com/gedex/inflector?status.svg)](https://godoc.org/github.com/gedex/inflector) ## Basic Usage There are only two exported functions: `Pluralize` and `Singularize`. ~~~go -s := "People" -fmt.Println(inflector.Singularize(s)) // will print "Person" - -s2 := "octopus" -fmt.Println(inflector.Pluralize(s2)) // will print "octopuses" +fmt.Println(inflector.Singularize("People")) // will print "Person" +fmt.Println(inflector.Pluralize("octopus")) // will print "octopuses" ~~~ -Please see [example/example.go](./example/example.go) for a complete example. - ## Credits * [CakePHP's Inflector](https://github.com/cakephp/cakephp/blob/master/lib/Cake/Utility/Inflector.php)