From 65561242ad2d20a26b826efd01b1782fc4cbd9e4 Mon Sep 17 00:00:00 2001 From: Jan Pilzer Date: Tue, 23 Oct 2018 11:38:56 -0700 Subject: [PATCH] Fix typos in readme --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c9bacbd..5ceaad0 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ # i18nextify -Just drop the [script](https://github.com/i18next/i18nextify/blob/master/i18nextify.min.js) on your page and your ready to deliver your pages in any language. +Just drop this [script](https://github.com/i18next/i18nextify/blob/master/i18nextify.min.js) on your page and you're ready to deliver your pages in any language. -See the [sample](http://i18next.github.io/i18nextify) ([code](https://github.com/i18next/i18nextify/tree/gh-pages))!! +See the [sample](https://i18next.github.io/i18nextify) ([code](https://github.com/i18next/i18nextify/tree/gh-pages))! -i18nextify uses virtual-dom to update your page with translations based on the current content. MutationObserver is used to trigger translations on newly added content. +*i18nextify* uses Virtual DOM to update your page with translations based on the current content. `MutationObserver` is used to trigger translations on newly added content. -i18nextify comes bundled with [i18next](http://i18next.com/). +*i18nextify* comes bundled with [i18next](https://i18next.com). -Should play well with any static or dynamic page not using a own virtual-dom. +Should play well with any static or dynamic page not using its own Virtual DOM. # Getting started -The easiest way for guaranteed success is using [locizify](http://locize.com/integration) on [locize.com](locize.com). +The easiest way for guaranteed success is using [locizify](https://www.npmjs.com/package/locizify) on [locize.com](https://locize.com). Alternatively: -Drop the [script](https://github.com/i18next/i18nextify/blob/master/i18nextify.min.js) on your page. +Drop this [script](https://github.com/i18next/i18nextify/blob/master/i18nextify.min.js) on your page. ```html @@ -27,7 +27,7 @@ Drop the [script](https://github.com/i18next/i18nextify/blob/master/i18nextify.m ... ``` -Request your page with querystring params `?debug=true&saveMissing` and open the browser console to see i18nextify in action. It will output all missing translations - start serving them from `/locales/{{lng}}/translation.json`. +Request your page with querystring params `?debug=true&saveMissing` and open the browser console to see *i18nextify* in action. It will output all missing translations - start serving them from `/locales/{{lng}}/translation.json`. See the [example](https://github.com/i18next/i18nextify/tree/master/example) for details. @@ -85,7 +85,7 @@ Just set translated attribute: Same could be done using options: -```html +```js mergeTags: [], // tags to merge innerHtml to one key inlineTags: [], // tags to inline (eg. a, span, abbr, ...) ignoreInlineOn: [], // tags to ignore inlining tags under inlineTags @@ -97,7 +97,7 @@ ignoreInlineOn: [], // tags to ignore inlining tags under inlineTags big A ``` -You will find `a.png` to be a key in your translation files - it's value can be replaced to eg. `a-de.png` for german (all other languages will fallback to `a.png`) +You will find `a.png` to be a key in your translation files - it's value can be replaced to eg. `a-de.png` for German (all other languages will fallback to `a.png`) ```html Open my statistics @@ -128,7 +128,7 @@ window.i18nextify.init({ ``` ```html - +
this won't get translated - nor this elements children
this won't get translated - nor this elements children
``` @@ -137,7 +137,7 @@ Just add `translated`-attribute ## Translating an element with options -For [extended translations](http://i18next.com/translate/) like plurals, interpolation, ... you need to add options to the element +For [extended translations](https://www.i18next.com/translation-function) like plurals, interpolation, ... you need to add options to the element ```html
@@ -146,7 +146,7 @@ For [extended translations](http://i18next.com/translate/) like plurals, interpo
``` -## Translating javascript code +## Translating JavaScript code You can use the [i18next](https://i18next.com) instance used to provide the translation functionality directly. Just make sure the instance is initialized already: @@ -220,7 +220,7 @@ window.i18nextify.init({ ... ``` -Just set the element style display to none. I18nextify will change it to block when ready. +Just set the element style display to none. *i18nextify* will change it to block when ready. ## Change File to use