From 2a89e57570df1d0c09c49884b31bce03d2812d94 Mon Sep 17 00:00:00 2001 From: Ma_124 Date: Tue, 3 Jul 2018 20:51:57 +0200 Subject: [PATCH] Updated readme --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b7e6014..1b05217 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,23 @@ -strcase [![Build Status](https://travis-ci.org/Ma124/strcase.svg)](https://travis-ci.org/Ma124/strcase) [![Coverage](http://gocover.io/_badge/github.com/Ma124/strcase?0)](http://gocover.io/github.com/Ma124/strcase) -======= +# strcase +[![Build Status](https://travis-ci.org/Ma124/strcase.svg)](https://travis-ci.org/Ma124/strcase) +[![Coverage](http://gocover.io/_badge/github.com/Ma124/strcase?0)](http://gocover.io/github.com/Ma124/strcase) +[![Godoc Reference](https://godoc.org/github.com/Ma124/strcase?status.svg)](http://godoc.org/github.com/Ma124/strcase) strcase is a go package for converting string case to [snake case](https://en.wikipedia.org/wiki/Snake_case) or [camel case](https://en.wikipedia.org/wiki/CamelCase). -# Example +## Example -``` +```go x := "AnyKind of_string" -xSnake := strcase.ToSnake(x) // any_kind_of_string -xCamel := strcase.ToCamel(x) // AnyKindOfString ``` + +| Function | Result | +|-----------------------------------|----------------------| +| `ToSnake(s)` | `any_kind_of_string` | +| `ToScreamingSnake(s)` | `ANY_KIND_OF_STRING` | +| `ToKebab(s)` | `any-kind-of-string` | +| `ToScreamingKebab(s)` | `ANY-KIND-OF-STRING` | +| `ToDelimited(s, '.')` | `any.kind.of.string` | +| `ToScreamingDelimited(s, '.')` | `ANY.KIND.OF.STRING` | +| `ToCamel(s)` | `AnyKindOfString` | +| `ToLowerCamel(s)` | `anyKindOfString` |