simonvareille
/
locales
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #15 from hotoo/doc 

doc(options.dirs): fix api doc
master
fengmk2 2015-09-21 13:35:21 +08:00
parent 64ea46d549 c4323c2a15
commit 205a58f270
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -20,10 +20,10 @@ koa-locales
koa locales, i18n solution for koa:
1. All locales resources location on `options.dir`.
2. resources file supports: `*.js`, `*.json` and `*.properties`, [examples](test/locales/)
3. One api: `__(key[, value, ...])`
4. Auto detect request locale from `query`, `cookie` and `header: Accept-Language`
1. All locales resources location on `options.dirs`.
2. resources file supports: `*.js`, `*.json` and `*.properties`, see [examples](test/locales/).
3. One api: `__(key[, value, ...])`.
4. Auto detect request locale from `query`, `cookie` and `header: Accept-Language`.
## Installation
@ -51,7 +51,7 @@ locales(app, options);
Patch locales functions to koa app.
- {Application} app: koa app instance.
- {Object} options: optional params
- {Object} options: optional params.
- {String} functionName: locale function name patch on koa context. Optional, default is `__`.
- {String} dirs: locales resources store directories. Optional, default is `['$PWD/locales']`.
- {String} defaultLocale: default locale. Optional, default is `en-US`.