Update readme for 0.0.6
This commit is contained in:
parent
33c218bf77
commit
15261e8ffa
29
README.md
29
README.md
|
@ -21,6 +21,9 @@ var Demo = React.createClass({
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Enable fallbacks if you want `en-US` and `en-GB` to fallback to `en`
|
||||||
|
I18n.fallbacks = true;
|
||||||
|
|
||||||
I18n.translations = {
|
I18n.translations = {
|
||||||
en: {
|
en: {
|
||||||
greeting: 'Hi!'
|
greeting: 'Hi!'
|
||||||
|
@ -33,7 +36,25 @@ I18n.translations = {
|
||||||
|
|
||||||
This will render `Hi!` for devices with the English locale, and `Bonjour!` for devices with the French locale.
|
This will render `Hi!` for devices with the English locale, and `Bonjour!` for devices with the French locale.
|
||||||
|
|
||||||
For more info about I18n.js methods (`localize`, `pluralize`, etc) and settings see [its documentation](https://github.com/fnando/i18n-js#setting-up).
|
### Fallbacks
|
||||||
|
When fallbacks are enabled (which is generally recommended), `i18n.js` will try to look up translations in the following order (for a device with `en_US` locale):
|
||||||
|
- en-US
|
||||||
|
- en
|
||||||
|
|
||||||
|
**Note**: iOS locales use underscored (`en_US`) but `i18n.js` locales are dasherized (`en-US`). This conversion is done automatically for you.
|
||||||
|
```js
|
||||||
|
I18n.fallbacks = true;
|
||||||
|
|
||||||
|
I18n.translations = {
|
||||||
|
'en': {
|
||||||
|
greeting: 'Hi!'
|
||||||
|
},
|
||||||
|
'en-GB': {
|
||||||
|
greeting: 'Hi from the UK!'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
For a device with a `en_GB` locale this will return `Hi from the UK!'`, for a device with a `en_US` locale it will return `Hi!`.
|
||||||
|
|
||||||
### Device's locale
|
### Device's locale
|
||||||
You can get the device's locale with the `RNI18n` native module:
|
You can get the device's locale with the `RNI18n` native module:
|
||||||
|
@ -41,6 +62,10 @@ You can get the device's locale with the `RNI18n` native module:
|
||||||
```js
|
```js
|
||||||
var deviceLocale = require('react-native').NativeModules.RNI18n.locale
|
var deviceLocale = require('react-native').NativeModules.RNI18n.locale
|
||||||
```
|
```
|
||||||
|
Returns `en_US`.
|
||||||
|
|
||||||
|
### I18n.js documentation
|
||||||
|
For more info about I18n.js methods (`localize`, `pluralize`, etc) and settings see [its documentation](https://github.com/fnando/i18n-js#setting-up).
|
||||||
|
|
||||||
## Licence
|
## Licence
|
||||||
MIT
|
MIT
|
||||||
|
|
Loading…
Reference in New Issue