Skip to content
This repository has been archived by the owner on Feb 24, 2024. It is now read-only.

Commit

Permalink
Add a README for the i18n middleware (#960)
Browse files Browse the repository at this point in the history
* Add a README for the i18n middleware

* Remove bad indentation
  • Loading branch information
stanislas-m committed May 12, 2018
1 parent 6f7d3a3 commit 35866e9
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions middleware/i18n/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
i18n middleware
===============

This Buffalo middleware enables i18n features in your app:
* User language detection from configurable sources
* Translation helper using locales bundles from github.com/nicksnyder/go-i18n
* Localized views

Installation
------------

This middleware is setup by default on a new Buffalo app:

**actions/app.go**
```go
var app *buffalo.App

// T is used to provide translations
var T *i18n.Translator

// App is where all routes and middleware for buffalo
// should be defined. This is the nerve center of your
// application.
func App() *buffalo.App {
if app == nil {
// [...]

// Setup and use translations:
var err error
if T, err = i18n.New(packr.NewBox("../locales"), "en"); err != nil {
app.Stop(err)
}
app.Use(T.Middleware())
}
return app
}
```

Use `i18n.New` to create a new instance of the translation module, then add the middleware (`T.Middleware()`) to the app to enable its features.

See https://gobuffalo.io/docs/localization for further info about Buffalo translation features and configuration.

0 comments on commit 35866e9

Please sign in to comment.