Skip to content

Commit

Permalink
Mention go module support in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stoewer committed Oct 31, 2018
1 parent f7df96f commit 36a5082
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 10 deletions.
45 changes: 36 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,55 @@
[![GoDoc](https://godoc.org/github.com/stoewer/go-strcase?status.svg)](https://godoc.org/github.com/stoewer/go-strcase)
---

# Go strcase
Go strcase
==========

The package `strcase` converts between different kinds of naming formats such as camel case
(`CamelCase`), snake case (`snake_case`) or kebab case (`kebab-case`).
The package is designed to work only with strings consisting of standard ASCII letters.
Unicode is currently not supported.

## Versioning and stability
Versioning and stability
------------------------

Although the master branch is supposed to remain always backward compatible, the repository
contains version tags in order to support vendoring tools such as `glide`.
contains version tags in order to support vendoring tools.
The tag names follow semantic versioning conventions and have the following format `v1.0.0`.
This package supports Go modules introduced with version 1.11.


## Install and use

```sh
go get -u github.com/stoewer/go-strcase
```
Example
-------

```go
import "github.com/stoewer/go-strcase"

var snake = strcase.SnakeCase("CamelCase")
```

Dependencies
------------

### Build dependencies

* none

### Test dependencies

* `github.com/stretchr/testify`

Run linters and unit tests
--------------------------

Since some of the linters ran by gometalinter don't support go modules yet, test dependencies have to be
loaded to the vendor directory first and gometalinter itself must run with disabled module support:

```
go mod vendor
GO111MODULE=off gometalinter --config=.gometalinter.json --deadline=10m .
```

To run the test use the following commands:

```
go test .
```
2 changes: 1 addition & 1 deletion doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// All rights reserved.

// Package strcase converts between different kinds of naming formats such as camel case
// (CamelCase), snake case (snake_case) or kebab case (`kebab-case`). The package is designed
// (CamelCase), snake case (snake_case) or kebab case (kebab-case). The package is designed
// to work only with strings consisting of standard ASCII letters. Unicode is currently not
// supported.
package strcase

0 comments on commit 36a5082

Please sign in to comment.