Skip to content

Commit ec44980

Browse files
alerquealerque
committed
docs: Overhaul all crate summaries to disambiguate and clarify scope of each
1 parent 20dd927 commit ec44980

File tree

18 files changed

+117
-63
lines changed

18 files changed

+117
-63
lines changed

‎README.md‎

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,46 @@
11
# 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)
22

3-
`fluent-rs` is a collection of Rust crates implementing [Project Fluent](https://projectfluent.org).
3+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
4+
a localization system designed to unleash the entire expressive power of natural language translations.
45

56
## Packages
67

7-
The crates perform the following functions:
8+
This workspace contains the following crates:
89

910
### fluent [![crates.io](https://img.shields.io/crates/v/fluent.svg)](https://crates.io/crates/fluent)
1011

11-
Umbrella crate combining crates that are ready to be used in production.
12-
13-
### fluent-syntax [![crates.io](https://img.shields.io/crates/v/fluent_syntax.svg)](https://crates.io/crates/fluent_syntax)
14-
15-
Low level Fluent Syntax AST and parser API.
12+
An umbrella crate exposing the combined features of fluent-rs crates with additional convenience macros.
1613

1714
### fluent-bundle [![crates.io](https://img.shields.io/crates/v/fluent_bundle.svg)](https://crates.io/crates/fluent_bundle)
1815

19-
Implementation of the low-level Fluent Localization System providing localization capabilities for any Rust project.
16+
A low level implementation of a collection of localization messages for a single locale.
2017

2118
### fluent-fallback [![crates.io](https://img.shields.io/crates/v/fluent_fallback.svg)](https://crates.io/crates/fluent_fallback)
2219

23-
Implementation of the high-level Fluent Localization System providing localization capabilities for any Rust project.
20+
A high-level abstraction model for managing locale bundles and runtime localization lifecycle.
2421

2522
### fluent-resmgr [![crates.io](https://img.shields.io/crates/v/fluent_resmgr.svg)](https://crates.io/crates/fluent_resmgr)
2623

27-
Resource Manager for localization resources.
24+
A standalone solution for managing localization resource files and returning locale bundles.
25+
26+
### fluent-syntax [![crates.io](https://img.shields.io/crates/v/fluent_syntax.svg)](https://crates.io/crates/fluent_syntax)
27+
28+
The low level parser, AST, and serializer APIs for the Fluent Syntax.
29+
30+
### fluent-pseudo [![crates.io](https://img.shields.io/crates/v/fluent_pseudo.svg)](https://crates.io/crates/fluent_pseudo)
31+
32+
A pseudolocalization and transformation API.
33+
34+
### fluent-testing [![crates.io](https://img.shields.io/crates/v/fluent_testing.svg)](https://crates.io/crates/fluent_testing)
35+
36+
A collection of mock scenarios for testing fluent-rs components.
37+
38+
### intl-memoizer [![crates.io](https://img.shields.io/crates/v/fluent_testing.svg)](https://crates.io/crates/fluent_testing)
39+
40+
A memoizer specifically tailored for storing lazy-initialized intl formatters.
2841

2942
### fluent-cli
3043

31-
Collection of command line tools for Fluent.
44+
A collection of developer-oriented command line tools for Fluent.
45+
46+
[Project Fluent]: https://projectfluent.org

‎fluent-bundle/Cargo.toml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
[package]
22
name = "fluent-bundle"
33
description = """
4-
A localization system designed to unleash the entire expressive power of
5-
natural language translations.
4+
Project Fluent is a localization system designed to unleash the entire
5+
expressive power of natural language translations. This crate exposes a low
6+
level implementation of a collection of localization messages for a single
7+
locale.
68
"""
79
version = "0.15.3"
810
edition.workspace = true

‎fluent-bundle/README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Fluent
1+
# Fluent Bundle
22

3-
`fluent-rs` is a Rust implementation of [Project Fluent][], a localization
4-
framework designed to unleash the entire expressive power of natural language
5-
translations.
3+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
4+
a localization system designed to unleash the entire expressive power of natural language translations.
5+
6+
This crate exposes a low level implementation of a collection of localization messages for a single locale.
67

78
[![crates.io](https://img.shields.io/crates/v/fluent-bundle.svg)](https://crates.io/crates/fluent-bundle)
89
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
@@ -15,7 +16,7 @@ natural languages like gender, plurals, conjugations, and others.
1516

1617
[Documentation][]
1718

18-
[Project Fluent]: http://projectfluent.org
19+
[Project Fluent]: https://projectfluent.org
1920
[Documentation]: https://docs.rs/fluent/
2021

2122
Usage

‎fluent-cli/Cargo.toml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
[package]
22
name = "fluent-cli"
33
description = """
4-
A collection of command line interface programs
5-
for Fluent Localization System.
4+
Project Fluent is a localization system designed to unleash the entire
5+
expressive power of natural language translations. This crate is
6+
collection of developer-oriented command line interface tools.
67
"""
78
version = "0.0.1"
89
edition.workspace = true

‎fluent-fallback/Cargo.toml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
[package]
22
name = "fluent-fallback"
33
description = """
4-
High-level abstraction model for managing localization resources
5-
and runtime localization lifecycle.
4+
Project Fluent is a localization system designed to unleash the entire
5+
expressive power of natural language translations. This crate exposes
6+
a high-level implementation of a collection of locale bundles including
7+
fallback between locales.
68
"""
79
version = "0.7.1"
810
edition.workspace = true

‎fluent-fallback/README.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
# Fluent
1+
# Fluent Fallback
22

3-
`fluent-fallback` is a Rust implementation of the [Project Fluent][] higher level API.
3+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
4+
a localization system designed to unleash the entire expressive power of natural language translations.
45

5-
The `Localization` struct encapsulates a persistent localization context providing
6-
language fallbacking. The instance remains available throughout the whole life cycle of
7-
the corresponding UI, reacting to events such as locale changes, resource updates etc.
8-
9-
The API can be used directly, or can serve as an example of state manager for `fluent-bundle` and `fluent-resmgr`.
6+
This crate exposes a high-level implementation of a collection of locale bundles including fallback between locales.
107

118
[![crates.io](https://img.shields.io/crates/v/fluent-fallback.svg)](https://crates.io/crates/fluent-fallback)
129
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
@@ -19,12 +16,18 @@ natural languages like gender, plurals, conjugations, and others.
1916

2017
[Documentation][]
2118

22-
[Project Fluent]: http://projectfluent.org
19+
[Project Fluent]: https://projectfluent.org
2320
[Documentation]: https://docs.rs/fluent/
2421

2522
Usage
2623
-----
2724

25+
The `Localization` struct encapsulates a persistent localization context providing language fallbacking.
26+
The instance remains available throughout the whole life cycle of the corresponding UI,
27+
reacting to events such as locale changes, resource updates etc.
28+
29+
The API can be used directly, or can serve as an example of state manager for `fluent-bundle` and `fluent-resmgr`.
30+
2831
```rust
2932
use fluent_fallback::Localization;
3033

‎fluent-pseudo/Cargo.toml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
[package]
22
name = "fluent-pseudo"
33
description = """
4-
Pseudolocalization transformation API for use with Project Fluent API.
4+
Project Fluent is a localization system designed to unleash the entire
5+
expressive power of natural language translations. This crate provides
6+
a pseudolocalization and transformation API.
57
"""
68
version = "0.3.2"
79
edition.workspace = true

‎fluent-pseudo/README.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
# Fluent
1+
# Fluent Pseudo
22

3-
`fluent-pseudo` is a Rust implementation of the pseudolocalization API for [Project Fluent](https://projectfluent.org/), a localization
4-
framework designed to unleash the entire expressive power of natural language
5-
translations.
3+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
4+
a localization system designed to unleash the entire expressive power of natural language translations.
5+
6+
This crate provides a pseudolocalization and transformation API.
67

78
[![crates.io](https://img.shields.io/crates/v/fluent-pseudo.svg)](https://crates.io/crates/fluent-pseudo)
89
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
910
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
1011

12+
[Project Fluent]: https://projectfluent.org
13+
1114
Usage
1215
-----
1316

‎fluent-resmgr/Cargo.toml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
[package]
22
name = "fluent-resmgr"
33
description = """
4-
Resource manager for Fluent localization resources.
4+
Project Fluent is a localization system designed to unleash the entire
5+
expressive power of natural language translations. This crate provides
6+
a standalone solution for managing localization resource files and returning
7+
locale bundles.
58
"""
69
version = "0.0.7"
710
edition.workspace = true

‎fluent-resmgr/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Fluent Resource Manager
22

3-
`fluent-resmgr` is an implementation of resource manager for [Project Fluent][].
3+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
4+
a localization system designed to unleash the entire expressive power of natural language translations.
45

5-
Resource Manager provides a standalone solution for managing localization resources which
6-
can be used by `fluent-fallback` or other higher level bindings.
6+
This crate provides a standalone solution for managing localization resource files and returning locale bundles.
77

88
[![crates.io](https://img.shields.io/crates/v/fluent-resmgr.svg)](https://crates.io/crates/fluent-resmgr)
99
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
@@ -16,7 +16,7 @@ natural languages like gender, plurals, conjugations, and others.
1616

1717
[Documentation][]
1818

19-
[Project Fluent]: http://projectfluent.org
19+
[Project Fluent]: https://projectfluent.org
2020
[Documentation]: https://docs.rs/fluent/
2121

2222
Usage

0 commit comments

Comments
 (0)