Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sveyret committed Jun 12, 2018
1 parent 5ae85ed commit 354c55a
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# intl-ts - Typesafe internationalization library

intl-ts is an i18n (internationlization) library for TypeScript. The package is compiled in ES5 and so can also be used by JavaScript applications. Its main features are:
intl-ts is an i18n (internationlization) library for TypeScript. The package is compiled in ES2015 and so can also be used by JavaScript applications, but may require a Babel translation to be used with browsers. Its main features are:

* Type safe: using a wrong message name or the wrong type for the parameters will be checked at compile time. If your IDE allow it, you may even have completion for message names.
* Immutable: except for JavaScript representation of the `LanguageMap` (because of lazy initialization) object states will never change. New object is created when calling `LanguageMap.merge` or `Intl.$withPreferences`. Good for most state-aware framework, like React/Redux.
Expand Down
2 changes: 1 addition & 1 deletion doc/fr/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# intl-ts - Bibliothèque d'internationalisation à typage sûr

intl-ts est une bibliothèque d'internationalisation (i18n) pour TypeScript. Le paquet est compilé en ES5 et peut donc également être utilisé par des applications JavaScript. Ses principales caractéristiques sont :
intl-ts est une bibliothèque d'internationalisation (i18n) pour TypeScript. Le paquet est compilé en ES2015 et peut donc également être utilisé par des applications JavaScript, mais peut potentiellement requérir une transformation par Babel pour être utilisé par les navigateurs. Ses principales caractéristiques sont :

* Typage sûr : l'utilisation d'un mauvais nom de message ou du mauvais type de paramètre est détecté à la compilation. Si votre EDI le permet, vous pouvez même avoir la complétion pour les noms de message.
* Immuable : excepté pour la représentation d'une `LanguageMap` en JavaScript (à cause d'une initialisation paresseuse), l'état des objets ne changera jamais. Un nouvel objet est créé lors de l'appel à `LanguageMap.merge` ou `Intl.$withPreferences`. Idéal pour la plupart des cadres basés sur les états, tel que React/Redux.
Expand Down
2 changes: 1 addition & 1 deletion doc/fr/tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,4 +196,4 @@ Ici, si la langue disponible ne définie pas la clé d'identification, on utilis

# Formater dates, nombres ou objets

Une fonction de formatage prend des paramètres et renvoie une chaine de caractère. C'est exactement ainsi que les fonctions de messages sont définies. Il est donc très simple de définir dans la table des message une fonction qui, en réalité, sera utilisée pour convertir n'importe quelle valeur en une chaine, et l'appeler au besoin. La méthode de formatage sera envoyée au besoin du serveur au navigateur comme tous les autres messages.
Une fonction de formatage prend des paramètres et renvoie une chaine de caractère. C'est exactement ainsi que les fonctions de messages sont définies. Il est donc très simple de définir dans la table des messages une fonction qui, en réalité, sera utilisée pour convertir n'importe quelle valeur en une chaine, et l'appeler au besoin. La méthode de formatage sera envoyée au besoin du serveur au navigateur comme tous les autres messages.

0 comments on commit 354c55a

Please sign in to comment.