diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..c7cb86e3d --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +[](http://travis-ci.org/SlexAxton/Jed) + +# Jed + +*Gettext Style i18n for Modern JavaScript Apps* + +For more info, please visit the docs site at <http://slexaxton.github.com/Jed>. + +## You sure you don't want something more modern? + +Jed is feature complete in my opinion. I am happy to fix bugs, but generally am not interested in adding more to the library. + +I also maintain [messageformat.js](https://github.com/SlexAxton/messageformat.js). If you don't specifically need a gettext implementation, I might suggest using MessageFormat instead, as it has better support for plurals/gender and has built-in locale data. + + +## Parsing Gettext Files + +Jed doesn't include a Gettext file parser, but several third-party parsers exist that can have their output adapted for Jed. + +#### Node + +Just search the npm repository, there are several PO and MO file parsers available. + +#### Browser + +[Jed Gettext Parser](https://github.com/WrinklyNinja/jed-gettext-parser) is the only known browser MO file parser, and it also works in Node, and outputs Jed-compatible data directly. + +[gettext.js](https://code.google.com/p/gettext-js) and [Pomo.js](https://github.com/cfv1984/pomo) both include browser-compatible PO file parsers. + +## Todo + +* Build time generation of plural form functions +* Web interface for building translation sets +* Code introspection for default values + +## License + +Jed is a member project of the [jQuery Foundation](https://jquery.org/) + +You may use this software under the MIT License. + +You may contribute to this software under the jQuery Foundation CLA - <https://contribute.jquery.org/CLA/> + + +## Author + +* Alex Sexton - @slexaxton - <https://alexsexton.com/> + + +## Credits + +A good chunk of sanity checking was done against the gettext.js tests. That was written by: + +* Joshua I. Miller + +The sprintf implementation is from: + +* Alexandru Marasteanu <alexaholic [at) gmail (dot] com> + + +## The name + +The name jed.js is an homage to Jed Schmidt (<https://github.com/jed>) the JavaScript community member who is a japanese translator by day, and a "hobbyist" JavaScript programmer by night. Give your kids three character names and they'll probably get software named after them too. |