diff --git a/fluent-bundle/README.md b/fluent-bundle/README.md index 089cbb7fd..eaf0e8cb9 100644 --- a/fluent-bundle/README.md +++ b/fluent-bundle/README.md @@ -1,8 +1,9 @@ # @fluent/bundle ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/bundle/badge.svg) -`@fluent/bundle` is a JavaScript implementation of Project Fluent, a -localization framework designed to unleash the expressive power of the -natural language. +`@fluent/bundle` is a JavaScript implementation of [Project Fluent][], +optimized for runtime performance. + +[Project Fluent]: https://projectfluent.org ## Installation @@ -63,13 +64,3 @@ See also the [Compatibility][] article on the `fluent.js` wiki. [intl-pluralrules]: https://www.npmjs.com/package/intl-pluralrules [Compatibility]: https://github.com/projectfluent/fluent.js/wiki/Compatibility - - -## Learn more - -Find out more about Project Fluent at [projectfluent.org][], including -documentation of the Fluent file format ([FTL][]), links to other packages and -implementations, and information about how to get involved. - -[projectfluent.org]: https://projectfluent.org -[FTL]: https://projectfluent.org/fluent/guide/ diff --git a/fluent-dedent/README.md b/fluent-dedent/README.md index 21d02a8d3..22e936804 100644 --- a/fluent-dedent/README.md +++ b/fluent-dedent/README.md @@ -1,10 +1,14 @@ # @fluent/dedent ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/dedent/badge.svg) -`@fluent/dedent` provides a template literal tag to dedent Fluent code. +`@fluent/dedent` provides a template literal tag to dedent Fluent code. It's +part of [Project Fluent][]. + Fluent Syntax is indentation-sensitive, and `@fluent/dedent` offers a convenient way to include Fluent snippets in source code keeping the current level of indentation and without compromising the readability. +[Project Fluent]: https://projectfluent.org + ## Installation @@ -74,13 +78,3 @@ let message = ftl` assert(message === "\nhello = Hello, world!\n"); ``` - - -## Learn more - -Find out more about Project Fluent at [projectfluent.org][], including -documentation of the Fluent file format ([FTL][]), links to other packages and -implementations, and information about how to get involved. - -[projectfluent.org]: https://projectfluent.org -[FTL]: https://projectfluent.org/fluent/guide/ diff --git a/fluent-dom/README.md b/fluent-dom/README.md index ec719f589..93b09f421 100644 --- a/fluent-dom/README.md +++ b/fluent-dom/README.md @@ -1,7 +1,9 @@ # @fluent/dom ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/dom/badge.svg) -`@fluent/dom` provides DOM bindings for Project Fluent, a localization -framework designed to unleash the expressive power of the natural language. +`@fluent/dom` provides the DOM bindings for [Project Fluent][]. + +[Project Fluent]: https://projectfluent.org + ## Installation @@ -62,13 +64,3 @@ async function main() { // → 'Welcome, Anna!' } ``` - -## Learn more - -Find out more about Project Fluent at [projectfluent.org][], including -documentation of the Fluent file format ([FTL][]), links to other packages and -implementations, and information about how to get involved. - - -[projectfluent.org]: https://projectfluent.org -[FTL]: https://projectfluent.org/fluent/guide/ diff --git a/fluent-gecko/README.md b/fluent-gecko/README.md index 096760ba6..41a825cd1 100644 --- a/fluent-gecko/README.md +++ b/fluent-gecko/README.md @@ -1,27 +1,13 @@ # fluent-gecko ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/gecko/badge.svg) -`fluent-gecko` is a Gecko-compatible distribution of Project Fluent, -a localization framework designed to unleash the expressive power of the -natural language. +`fluent-gecko` is a Gecko-compatible distribution of [Project Fluent][]. +[Project Fluent]: https://projectfluent.org -## How to use - -The `fluent-gecko` build system produces `*.jsm` files which are ready to be -used as Gecko modules. - -`Fluent.jsm` exports the `FluentBundle` constructor which provides the -core functionality of formatting translations from FTL files. See the -[README][] of the main `fluent` package for more information. +## How to use -## Learn more - -Find out more about Project Fluent at [projectfluent.org][], including -documentation of the Fluent file format ([FTL][]), links to other packages and -implementations, and information about how to get involved. - +`fluent-gecko` can build files ready for vendoring into `mozilla-central`. -[README]: ../fluent/README.md -[projectfluent.org]: https://projectfluent.org -[FTL]: https://projectfluent.org/fluent/guide/ + - [`FluentSyntax.jsm`](https://searchfox.org/mozilla-central/source/intl/l10n/FluentSyntax.jsm) + - [`fluent-react.js`](https://searchfox.org/mozilla-central/source/devtools/client/shared/vendor/fluent-react.js) diff --git a/fluent-langneg/README.md b/fluent-langneg/README.md index 372392ecd..039f010cf 100644 --- a/fluent-langneg/README.md +++ b/fluent-langneg/README.md @@ -1,12 +1,11 @@ # @fluent/langneg ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/langneg/badge.svg) -`@fluent/langneg` is an API for negotiating languages. It's part of Project -Fluent, a localization framework designed to unleash the expressive power of -the natural language. - -It's main function is to provide functionality around the [Intl.Locale][] API -with a focus on language negotiation, matching and selection. +`@fluent/langneg` provides an API for negotiating languages. It's part of +[Project Fluent][]. Its main function is to provide functionality around the +[Intl.Locale][] API with a focus on language negotiation, matching and +selection. +[Project Fluent]: https://projectfluent.org [Intl.Locale]: https://github.com/tc39/proposal-intl-locale @@ -89,12 +88,3 @@ in case the requested locale is too generic. An example of that scenario is when the user requests `en` locale, and the application supports `en-GB` and `en-US`. - -## Learn more - -Find out more about Project Fluent at [projectfluent.org][], including -documentation of the Fluent file format ([FTL][]), links to other packages and -implementations, and information about how to get involved. - -[projectfluent.org]: https://projectfluent.org -[FTL]: https://projectfluent.org/fluent/guide/ diff --git a/fluent-react/README.md b/fluent-react/README.md index 8eb5fdd18..b75da6b4d 100644 --- a/fluent-react/README.md +++ b/fluent-react/README.md @@ -1,7 +1,8 @@ # @fluent/react ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/react/badge.svg) -`@fluent/react` provides React bindings for Project Fluent, a localization -framework designed to unleash the expressive power of the natural language. +`@fluent/react` provides the React bindings for [Project Fluent][]. + +[Project Fluent]: https://projectfluent.org ## Installation @@ -31,13 +32,3 @@ Consult the [wiki][] for documentation on how to set up and use The API reference is available at https://projectfluent.org/fluent.js/react. [wiki]: https://github.com/projectfluent/fluent.js/wiki/React-Bindings - - -## Learn more - -Find out more about Project Fluent at [projectfluent.org][], including -documentation of the Fluent file format ([FTL][]), links to other packages and -implementations, and information about how to get involved. - -[projectfluent.org]: https://projectfluent.org -[FTL]: https://projectfluent.org/fluent/guide/ diff --git a/fluent-sequence/README.md b/fluent-sequence/README.md index 95f82baed..243f4e242 100644 --- a/fluent-sequence/README.md +++ b/fluent-sequence/README.md @@ -2,8 +2,9 @@ `@fluent/sequence` provides mapping functions from string identifiers to `FluentBundle` instances taken from synchronous or asynchronous sequences. -It's part of Project Fluent, a localization framework designed to unleash the -expressive power of the natural language. +It's part of [Project Fluent][]. + +[Project Fluent]: https://projectfluent.org ## Installation @@ -56,13 +57,3 @@ The API reference is available at https://projectfluent.org/fluent.js/sequence. [`cached-iterable`]: https://www.npmjs.com/package/cached-iterable - - -## Learn more - -Find out more about Project Fluent at [projectfluent.org][], including -documentation of the Fluent file format ([FTL][]), links to other packages and -implementations, and information about how to get involved. - -[projectfluent.org]: https://projectfluent.org -[FTL]: https://projectfluent.org/fluent/guide/ diff --git a/fluent-syntax/README.md b/fluent-syntax/README.md index 943c08d92..6dbea5840 100644 --- a/fluent-syntax/README.md +++ b/fluent-syntax/README.md @@ -1,9 +1,9 @@ # @fluent/syntax ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/syntax/badge.svg) -`@fluent/syntax` is a parser for Fluent translation files, FTL. Project -Fluent is a localization framework designed to unleash the expressive power -of the natural language. +`@fluent/syntax` is a tooling library for parsing, serializing, and working +with the Fluent syntax. It's part of [Project Fluent][]. +[Project Fluent]: https://projectfluent.org ## Installation @@ -28,13 +28,3 @@ assert(res instanceof Resource); ``` The API reference is available at https://projectfluent.org/fluent.js/syntax. - - -## Learn more - -Find out more about Project Fluent at [projectfluent.org][], including -documentation of the Fluent file format ([FTL][]), links to other packages and -implementations, and information about how to get involved. - -[projectfluent.org]: https://projectfluent.org -[FTL]: https://projectfluent.org/fluent/guide/