Update README

This commit is contained in:
Leonel Quinteros
2018-09-12 15:31:27 -03:00
parent 477ce49ddf
commit 7b73c0d36b

View File

@@ -25,6 +25,7 @@
- Language codes are automatically simplified from the form `en_UK` to `en` if the first isn't available.
- Ready to use inside Go templates.
- Objects are serializable to []byte to store them in cache.
- Support for Go Modules.
# License
@@ -48,14 +49,14 @@ go get github.com/leonelquinteros/gotext
- No need for environment variables. Some naming conventions are applied but not needed.
### Version vendoring
## Version vendoring
Stable releases use [semantic versioning](http://semver.org/spec/v2.0.0.html) tagging on this repository.
You can rely on this to use your preferred vendoring tool or to manually retrieve the corresponding release tag from the GitHub repository.
#### Vendoring with [dep](https://golang.github.io/dep/)
### Vendoring with [dep](https://golang.github.io/dep/)
To use last stable version (v1.3.1 at the moment of writing)
@@ -70,7 +71,7 @@ import "github.com/leonelquinteros/gotext"
```
#### Vendoring with [gopkg.in](http://labix.org/gopkg.in)
### Vendoring with [gopkg.in](http://labix.org/gopkg.in)
[http://gopkg.in/leonelquinteros/gotext.v1](http://gopkg.in/leonelquinteros/gotext.v1)
@@ -89,6 +90,18 @@ import "gopkg.in/leonelquinteros/gotext.v1"
Refer to it as gotext.
### Vendoring with [Go Modules](https://github.com/golang/go/wiki/Modules)
Add `github.com/leonelquinteros/gotext` inside the `require` section in your `go.mod` file.
i.e.
```
require (
github.com/leonelquinteros/gotext v1.4.0
)
```
# Locales directories structure
The package will assume a directories structure starting with a base path that will be provided to the package configuration