diff --git a/README.md b/README.md index 43ccd1fc..ca731e37 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], a localization system designed to unleash the entire expressive power of natural language translations. +Project Fluent keeps simple things simple and makes complex things possible. +The syntax used for describing translations is easy to read and understand. +At the same time it allows, when necessary, to represent complex concepts from natural languages like gender, plurals, conjugations, and others. + ## Packages This workspace contains the following crates: diff --git a/fluent-bundle/README.md b/fluent-bundle/README.md index 16b8ce19..e032bd52 100644 --- a/fluent-bundle/README.md +++ b/fluent-bundle/README.md @@ -1,24 +1,16 @@ # Fluent Bundle -The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], -a localization system designed to unleash the entire expressive power of natural language translations. - -This crate exposes a low level implementation of a collection of localization messages for a single locale. - [![crates.io](https://img.shields.io/crates/v/fluent-bundle.svg)](https://crates.io/crates/fluent-bundle) [![docs.rs](https://img.shields.io/docsrs/fluent-bundle)](https://docs.rs/fluent-bundle)] [![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) -Project Fluent keeps simple things simple and makes complex things possible. -The syntax used for describing translations is easy to read and understand. At -the same time it allows, when necessary, to represent complex concepts from -natural languages like gender, plurals, conjugations, and others. +The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], +a localization system designed to unleash the entire expressive power of natural language translations. -[Documentation][] +This crate exposes a low level implementation of a collection of localization messages for a single locale. [Project Fluent]: https://projectfluent.org -[Documentation]: https://docs.rs/fluent/ Usage ----- @@ -49,26 +41,6 @@ fn main() { } ``` - -Learn the FTL syntax --------------------- - -FTL is a localization file format used for describing translation resources. -FTL stands for _Fluent Translation List_. - -FTL is designed to be simple to read, but at the same time allows to represent -complex concepts from natural languages like gender, plurals, conjugations, and -others. - - hello-user = Hello, { $username }! - -[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If -you're a tool author you may be interested in the formal [EBNF grammar][]. - -[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/ -[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec - - Get Involved ------------ diff --git a/fluent-fallback/README.md b/fluent-fallback/README.md index 57d1ae7e..4015d6bd 100644 --- a/fluent-fallback/README.md +++ b/fluent-fallback/README.md @@ -1,24 +1,16 @@ # Fluent Fallback -The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], -a localization system designed to unleash the entire expressive power of natural language translations. - -This crate exposes a high-level implementation of a collection of locale bundles including fallback between locales. - [![crates.io](https://img.shields.io/crates/v/fluent-fallback.svg)](https://crates.io/crates/fluent-fallback) [![docs.rs](https://img.shields.io/docsrs/fluent-fallback)](https://docs.rs/fluent-fallback)] [![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) -Project Fluent keeps simple things simple and makes complex things possible. -The syntax used for describing translations is easy to read and understand. At -the same time it allows, when necessary, to represent complex concepts from -natural languages like gender, plurals, conjugations, and others. +The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], +a localization system designed to unleash the entire expressive power of natural language translations. -[Documentation][] +This crate exposes a high-level implementation of a collection of locale bundles including fallback between locales. [Project Fluent]: https://projectfluent.org -[Documentation]: https://docs.rs/fluent/ Usage ----- @@ -43,26 +35,6 @@ fn main() { } ``` - -Learn the FTL syntax --------------------- - -FTL is a localization file format used for describing translation resources. -FTL stands for _Fluent Translation List_. - -FTL is designed to be simple to read, but at the same time allows to represent -complex concepts from natural languages like gender, plurals, conjugations, and -others. - - hello-user = Hello, { $username }! - -[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If -you're a tool author you may be interested in the formal [EBNF grammar][]. - -[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/ -[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec - - Get Involved ------------ diff --git a/fluent-pseudo/README.md b/fluent-pseudo/README.md index 5104908f..f61204dd 100644 --- a/fluent-pseudo/README.md +++ b/fluent-pseudo/README.md @@ -1,15 +1,15 @@ # Fluent Pseudo -The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], -a localization system designed to unleash the entire expressive power of natural language translations. - -This crate provides a pseudolocalization and transformation API. - [![crates.io](https://img.shields.io/crates/v/fluent-pseudo.svg)](https://crates.io/crates/fluent-pseudo) [![docs.rs](https://img.shields.io/docsrs/fluent-pseudo)](https://docs.rs/fluent-pseudo)] [![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) +The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], +a localization system designed to unleash the entire expressive power of natural language translations. + +This crate provides a pseudolocalization and transformation API. + [Project Fluent]: https://projectfluent.org Usage diff --git a/fluent-resmgr/README.md b/fluent-resmgr/README.md index c836dbae..8cc3f7c7 100644 --- a/fluent-resmgr/README.md +++ b/fluent-resmgr/README.md @@ -1,24 +1,16 @@ # Fluent Resource Manager -The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], -a localization system designed to unleash the entire expressive power of natural language translations. - -This crate provides a standalone solution for managing localization resource files and returning locale bundles. - [![crates.io](https://img.shields.io/crates/v/fluent-resmgr.svg)](https://crates.io/crates/fluent-resmgr) [![docs.rs](https://img.shields.io/docsrs/fluent-resmgr)](https://docs.rs/fluent-resmgr)] [![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) -Project Fluent keeps simple things simple and makes complex things possible. -The syntax used for describing translations is easy to read and understand. At -the same time it allows, when necessary, to represent complex concepts from -natural languages like gender, plurals, conjugations, and others. +The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], +a localization system designed to unleash the entire expressive power of natural language translations. -[Documentation][] +This crate provides a standalone solution for managing localization resource files and returning locale bundles. [Project Fluent]: https://projectfluent.org -[Documentation]: https://docs.rs/fluent/ Usage ----- @@ -37,26 +29,6 @@ fn main() { } ``` - -Learn the FTL syntax --------------------- - -FTL is a localization file format used for describing translation resources. -FTL stands for _Fluent Translation List_. - -FTL is designed to be simple to read, but at the same time allows to represent -complex concepts from natural languages like gender, plurals, conjugations, and -others. - - hello-user = Hello, { $username }! - -[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If -you're a tool author you may be interested in the formal [EBNF grammar][]. - -[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/ -[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec - - Get Involved ------------ diff --git a/fluent-syntax/README.md b/fluent-syntax/README.md index dd86b5da..f47d4c6c 100644 --- a/fluent-syntax/README.md +++ b/fluent-syntax/README.md @@ -1,35 +1,16 @@ # Fluent Syntax -The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], -a localization system designed to unleash the entire expressive power of natural language translations. - -This crate exposes the low level parser, AST, and serializer APIs for the Fluent Syntax. - [![crates.io](https://img.shields.io/crates/v/fluent-syntax.svg)](https://crates.io/crates/fluent-syntax) [![docs.rs](https://img.shields.io/docsrs/fluent-syntax)](https://docs.rs/fluent-syntax)] [![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) -[Project Fluent]: https://projectfluent.org - -Learn the FTL syntax --------------------- - -FTL is a localization file format used for describing translation resources. -FTL stands for _Fluent Translation List_. - -FTL is designed to be simple to read, but at the same time allows to represent -complex concepts from natural languages like gender, plurals, conjugations, and -others. - - hello-user = Hello, { $username }! - -[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If -you're a tool author you may be interested in the formal [EBNF grammar][]. +The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], +a localization system designed to unleash the entire expressive power of natural language translations. -[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/ -[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec +This crate exposes the low level parser, AST, and serializer APIs for the Fluent Syntax. +[Project Fluent]: https://projectfluent.org Get Involved ------------ diff --git a/fluent-testing/README.md b/fluent-testing/README.md index 3788ce68..9dde55c1 100644 --- a/fluent-testing/README.md +++ b/fluent-testing/README.md @@ -1,40 +1,16 @@ # Fluent Testing -The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], -a localization system designed to unleash the entire expressive power of natural language translations. - -This crate is a collection of mock scenarios for testing fluent-rs components. - [![crates.io](https://img.shields.io/crates/v/fluent-bundle.svg)](https://crates.io/crates/fluent-bundle) [![docs.rs](https://img.shields.io/docsrs/fluent-testing)](https://docs.rs/fluent-testing)] [![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) -Project Fluent keeps simple things simple and makes complex things possible. -The syntax used for describing translations is easy to read and understand. At -the same time it allows, when necessary, to represent complex concepts from -natural languages like gender, plurals, conjugations, and others. - -[Project Fluent]: https://projectfluent.org - -Learn the FTL syntax --------------------- - -FTL is a localization file format used for describing translation resources. -FTL stands for _Fluent Translation List_. - -FTL is designed to be simple to read, but at the same time allows to represent -complex concepts from natural languages like gender, plurals, conjugations, and -others. - - hello-user = Hello, { $username }! - -[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If -you're a tool author you may be interested in the formal [EBNF grammar][]. +The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], +a localization system designed to unleash the entire expressive power of natural language translations. -[Read the Fluent Syntax Guide]: https://projectfluent.org/fluent/guide/ -[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec +This crate is a collection of mock scenarios for testing fluent-rs components. +[Project Fluent]: https://projectfluent.org Get Involved ------------ diff --git a/fluent/README.md b/fluent/README.md index 97e4b0f8..12f0047b 100644 --- a/fluent/README.md +++ b/fluent/README.md @@ -1,24 +1,16 @@ # Fluent -The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], -a localization system designed to unleash the entire expressive power of natural language translations. - -This crate is an umbrella that exposes the combined features of other `fluent-rs` crates with additional convenience macros. - [![crates.io](https://img.shields.io/crates/v/fluent.svg)](https://crates.io/crates/fluent) [![docs.rs](https://img.shields.io/docsrs/fluent)](https://docs.rs/fluent)] [![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) -Project Fluent keeps simple things simple and makes complex things possible. -The syntax used for describing translations is easy to read and understand. At -the same time it allows, when necessary, to represent complex concepts from -natural languages like gender, plurals, conjugations, and others. +The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], +a localization system designed to unleash the entire expressive power of natural language translations. -[Documentation][] +This crate is an umbrella that exposes the combined features of other `fluent-rs` crates with additional convenience macros. [Project Fluent]: https://projectfluent.org -[Documentation]: https://docs.rs/fluent/ Usage ----- diff --git a/intl-memoizer/README.md b/intl-memoizer/README.md index b2c54098..c818f437 100644 --- a/intl-memoizer/README.md +++ b/intl-memoizer/README.md @@ -1,15 +1,15 @@ # IntlMemoizer -The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], -a localization system designed to unleash the entire expressive power of natural language translations. - -This crate provides a memoizer specifically tailored for storing lazy-initialized intl formatters. - [![crates.io](https://img.shields.io/crates/v/intl-memoizer.svg)](https://crates.io/crates/intl-memoizer) [![docs.rs](https://img.shields.io/docsrs/intl-memoizer)](https://docs.rs/intl-memoizer)] [![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) +The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][], +a localization system designed to unleash the entire expressive power of natural language translations. + +This crate provides a memoizer specifically tailored for storing lazy-initialized intl formatters. + [Project Fluent]: https://projectfluent.org Usage