1- Project Fluent
2- ==============
1+ # Project Fluent
32
43Fluent.js is a JavaScript implementation of Project Fluent, a localization
54framework designed to unleash the expressive power of the natural language.
65
76Project Fluent keeps simple things simple and makes complex things possible.
8- The syntax used for describing translations is easy to read and understand. At
7+ The syntax used for describing translations is easy to read and understand. At
98the same time it allows, when necessary, to represent complex concepts from
109natural languages like gender, plurals, conjugations, and others.
1110
12-
13- Packages
14- --------
11+ ## Packages
1512
1613Fluent.js consists of a set of packages which have different use-cases and can
1714be installed independently of each other.
1815
19- - [ @fluent/bundle ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-bundle )
20- - [ @fluent/dedent ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-dedent )
21- - [ @fluent/dom ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-dom )
22- - [ @fluent/langneg ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-langneg )
23- - [ @fluent/react ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-react )
24- - [ @fluent/sequence ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-sequence )
25- - [ @fluent/syntax ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-syntax )
16+ - [ @fluent/bundle ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-bundle )
17+ - [ @fluent/dedent ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-dedent )
18+ - [ @fluent/dom ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-dom )
19+ - [ @fluent/langneg ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-langneg )
20+ - [ @fluent/react ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-react )
21+ - [ @fluent/sequence ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-sequence )
22+ - [ @fluent/syntax ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-syntax )
2623
2724You can install each of the above packages via ` npm ` , e.g. ` npm install @fluent/react ` .
2825See the end of this ` README ` for instructions on how to build ` fluent.js ` locally.
2926
30-
31- Learn the FTL syntax
32- --------------------
27+ ## Learn the FTL syntax
3328
3429FTL is a localization file format used for describing translation resources.
3530FTL stands for _ Fluent Translation List_ .
@@ -40,34 +35,28 @@ and others.
4035
4136 hello-user = Hello, { $username }!
4237
43- [ Read the Fluent Syntax Guide] [ ] in order to learn more about the syntax. If
38+ [ Read the Fluent Syntax Guide] [ ] in order to learn more about the syntax. If
4439you're a tool author you may be interested in the formal [ EBNF grammar] [ ] .
4540
46- [ Read the Fluent Syntax Guide ] : https://projectfluent.org/fluent/guide/
47- [ EBNF grammar ] : https://github.com/projectfluent/fluent/tree/master/spec
48-
41+ [ read the fluent syntax guide ] : https://projectfluent.org/fluent/guide/
42+ [ ebnf grammar ] : https://github.com/projectfluent/fluent/tree/master/spec
4943
50- Discuss
51- -------
44+ ## Discuss
5245
53- We'd love to hear your thoughts on Project Fluent! Whether you're a localizer looking
54- for a better way to express yourself in your language, or a developer trying to
55- make your app localizable and multilingual, or a hacker looking for a project
46+ We'd love to hear your thoughts on Project Fluent! Whether you're a localizer looking
47+ for a better way to express yourself in your language, or a developer trying to
48+ make your app localizable and multilingual, or a hacker looking for a project
5649to contribute to, please do get in touch!
5750
58- - Discourse: https://discourse.mozilla.org/c/fluent
51+ - Discourse: https://discourse.mozilla.org/c/fluent
5952
53+ ## Get Involved
6054
61- Get Involved
62- ------------
63-
64- Fluent.js is open-source, licensed under the Apache License, Version 2.0. We
65- encourage everyone to take a look at our code and we'll listen to your
55+ Fluent.js is open-source, licensed under the Apache License, Version 2.0. We
56+ encourage everyone to take a look at our code and we'll listen to your
6657feedback.
6758
68-
69- Local Development
70- -----------------
59+ ## Local Development
7160
7261Hacking on ` fluent.js ` is easy! To quickly get started clone the repo:
7362
0 commit comments