mirror of
https://github.com/cupcakearmy/svelte-i18n.git
synced 2024-06-30 18:54:49 +02:00
docs: ✏️ add tiny example to readme
This commit is contained in:
parent
7721b64e25
commit
ea2ac47d14
38
README.md
38
README.md
|
@ -6,9 +6,43 @@
|
||||||
|
|
||||||
`svelte-i18n` helps you localize your app using the reactive tools Svelte provides. By using [stores](https://svelte.dev/docs#svelte_store) to keep track of the current `locale`, `dictionary` of messages and to `format` messages, we keep everything neat, in sync and easy to use on your svelte files.
|
`svelte-i18n` helps you localize your app using the reactive tools Svelte provides. By using [stores](https://svelte.dev/docs#svelte_store) to keep track of the current `locale`, `dictionary` of messages and to `format` messages, we keep everything neat, in sync and easy to use on your svelte files.
|
||||||
|
|
||||||
### [Go to documentation](https://github.com/kaisermann/svelte-i18n/wiki)
|
|
||||||
|
|
||||||
**Requirements**
|
**Requirements**
|
||||||
|
|
||||||
- Node: `>= 11.15.0`
|
- Node: `>= 11.15.0`
|
||||||
- Browsers: `Chrome 38+`, `Edge 12+`, `Firefox 13+`, `Opera 25+`, `Safari 8+`.
|
- Browsers: `Chrome 38+`, `Edge 12+`, `Firefox 13+`, `Opera 25+`, `Safari 8+`.
|
||||||
|
|
||||||
|
```svelte
|
||||||
|
<script>
|
||||||
|
import { _ } from 'svelte-i18n'
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<h1>{$_('page.home.title')}</h1>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a>{$_('page.home.nav', { default: 'Home' })}</a>
|
||||||
|
<a>{$_('page.about.nav', { default: 'About' })}</a>
|
||||||
|
<a>{$_('page.contact.nav', { default: 'Contact' })}</a>
|
||||||
|
</nav>
|
||||||
|
```
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
// en.json
|
||||||
|
{
|
||||||
|
"page": {
|
||||||
|
"home": {
|
||||||
|
"title": "Homepage",
|
||||||
|
"nav": "Home"
|
||||||
|
},
|
||||||
|
"about": {
|
||||||
|
"title": "About",
|
||||||
|
"nav": "About"
|
||||||
|
},
|
||||||
|
"contact": {
|
||||||
|
"title": "Contact",
|
||||||
|
"nav": "Contact Us"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### [Go to documentation](https://github.com/kaisermann/svelte-i18n/wiki)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user