Browse Source

Updated readme

tags/v0.1.0
Ma_124 5 years ago
parent
commit
2a89e57570
1 changed files with 17 additions and 6 deletions
  1. +17
    -6
      README.md

+ 17
- 6
README.md View File

@@ -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` |

Loading…
Cancel
Save