DeineAgenturUG/gotext
1
0
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity

Update README

Browse Source
This commit is contained in:
Leonel Quinteros
2018-09-12 15:31:27 -03:00
parent 477ce49ddf
commit 7b73c0d36b
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -25,6 +25,7 @@
- Language codes are automatically simplified from the form `en_UK` to `en` if the first isn't available. - Language codes are automatically simplified from the form `en_UK` to `en` if the first isn't available.
- Ready to use inside Go templates. - Ready to use inside Go templates.
- Objects are serializable to []byte to store them in cache. - Objects are serializable to []byte to store them in cache.
- Support for Go Modules.
# License # License
@@ -48,14 +49,14 @@ go get github.com/leonelquinteros/gotext
- No need for environment variables. Some naming conventions are applied but not needed. - 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. 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. 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) 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) [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. 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 # Locales directories structure
The package will assume a directories structure starting with a base path that will be provided to the package configuration The package will assume a directories structure starting with a base path that will be provided to the package configuration