Skip to content

Commit 36e55c0

Browse files
alerquealerque
committed
docs: Ditch extended ecosystem boilerplate in specific crates
1 parent 3a4cd79 commit 36e55c0

File tree

9 files changed

+34
-165
lines changed

9 files changed

+34
-165
lines changed

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
77
a localization system designed to unleash the entire expressive power of natural language translations.
88

9+
Project Fluent keeps simple things simple and makes complex things possible.
10+
The syntax used for describing translations is easy to read and understand.
11+
At the same time it allows, when necessary, to represent complex concepts from natural languages like gender, plurals, conjugations, and others.
12+
913
## Packages
1014

1115
This workspace contains the following crates:

‎fluent-bundle/README.md‎

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,16 @@
11
# Fluent Bundle
22

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.
7-
83
[![crates.io](https://img.shields.io/crates/v/fluent-bundle.svg)](https://crates.io/crates/fluent-bundle)
94
[![docs.rs](https://img.shields.io/docsrs/fluent-bundle)](https://docs.rs/fluent-bundle)
105
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
116
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
127

13-
Project Fluent keeps simple things simple and makes complex things possible.
14-
The syntax used for describing translations is easy to read and understand. At
15-
the same time it allows, when necessary, to represent complex concepts from
16-
natural languages like gender, plurals, conjugations, and others.
8+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
9+
a localization system designed to unleash the entire expressive power of natural language translations.
1710

18-
[Documentation][]
11+
This crate exposes a low level implementation of a collection of localization messages for a single locale.
1912

2013
[Project Fluent]: https://projectfluent.org
21-
[Documentation]: https://docs.rs/fluent/
2214

2315
Usage
2416
-----
@@ -49,26 +41,6 @@ fn main() {
4941
}
5042
```
5143

52-
53-
Learn the FTL syntax
54-
--------------------
55-
56-
FTL is a localization file format used for describing translation resources.
57-
FTL stands for _Fluent Translation List_.
58-
59-
FTL is designed to be simple to read, but at the same time allows to represent
60-
complex concepts from natural languages like gender, plurals, conjugations, and
61-
others.
62-
63-
hello-user = Hello, { $username }!
64-
65-
[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If
66-
you're a tool author you may be interested in the formal [EBNF grammar][].
67-
68-
[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/
69-
[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec
70-
71-
7244
Get Involved
7345
------------
7446

‎fluent-fallback/README.md‎

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,16 @@
11
# Fluent Fallback
22

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 high-level implementation of a collection of locale bundles including fallback between locales.
7-
83
[![crates.io](https://img.shields.io/crates/v/fluent-fallback.svg)](https://crates.io/crates/fluent-fallback)
94
[![docs.rs](https://img.shields.io/docsrs/fluent-fallback)](https://docs.rs/fluent-fallback)
105
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
116
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
127

13-
Project Fluent keeps simple things simple and makes complex things possible.
14-
The syntax used for describing translations is easy to read and understand. At
15-
the same time it allows, when necessary, to represent complex concepts from
16-
natural languages like gender, plurals, conjugations, and others.
8+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
9+
a localization system designed to unleash the entire expressive power of natural language translations.
1710

18-
[Documentation][]
11+
This crate exposes a high-level implementation of a collection of locale bundles including fallback between locales.
1912

2013
[Project Fluent]: https://projectfluent.org
21-
[Documentation]: https://docs.rs/fluent/
2214

2315
Usage
2416
-----
@@ -43,26 +35,6 @@ fn main() {
4335
}
4436
```
4537

46-
47-
Learn the FTL syntax
48-
--------------------
49-
50-
FTL is a localization file format used for describing translation resources.
51-
FTL stands for _Fluent Translation List_.
52-
53-
FTL is designed to be simple to read, but at the same time allows to represent
54-
complex concepts from natural languages like gender, plurals, conjugations, and
55-
others.
56-
57-
hello-user = Hello, { $username }!
58-
59-
[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If
60-
you're a tool author you may be interested in the formal [EBNF grammar][].
61-
62-
[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/
63-
[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec
64-
65-
6638
Get Involved
6739
------------
6840

‎fluent-pseudo/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Fluent Pseudo
22

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.
7-
83
[![crates.io](https://img.shields.io/crates/v/fluent-pseudo.svg)](https://crates.io/crates/fluent-pseudo)
94
[![docs.rs](https://img.shields.io/docsrs/fluent-pseudo)](https://docs.rs/fluent-pseudo)
105
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
116
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
127

8+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
9+
a localization system designed to unleash the entire expressive power of natural language translations.
10+
11+
This crate provides a pseudolocalization and transformation API.
12+
1313
[Project Fluent]: https://projectfluent.org
1414

1515
Usage

‎fluent-resmgr/README.md‎

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,16 @@
11
# Fluent Resource Manager
22

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 standalone solution for managing localization resource files and returning locale bundles.
7-
83
[![crates.io](https://img.shields.io/crates/v/fluent-resmgr.svg)](https://crates.io/crates/fluent-resmgr)
94
[![docs.rs](https://img.shields.io/docsrs/fluent-resmgr)](https://docs.rs/fluent-resmgr)
105
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
116
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
127

13-
Project Fluent keeps simple things simple and makes complex things possible.
14-
The syntax used for describing translations is easy to read and understand. At
15-
the same time it allows, when necessary, to represent complex concepts from
16-
natural languages like gender, plurals, conjugations, and others.
8+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
9+
a localization system designed to unleash the entire expressive power of natural language translations.
1710

18-
[Documentation][]
11+
This crate provides a standalone solution for managing localization resource files and returning locale bundles.
1912

2013
[Project Fluent]: https://projectfluent.org
21-
[Documentation]: https://docs.rs/fluent/
2214

2315
Usage
2416
-----
@@ -37,26 +29,6 @@ fn main() {
3729
}
3830
```
3931

40-
41-
Learn the FTL syntax
42-
--------------------
43-
44-
FTL is a localization file format used for describing translation resources.
45-
FTL stands for _Fluent Translation List_.
46-
47-
FTL is designed to be simple to read, but at the same time allows to represent
48-
complex concepts from natural languages like gender, plurals, conjugations, and
49-
others.
50-
51-
hello-user = Hello, { $username }!
52-
53-
[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If
54-
you're a tool author you may be interested in the formal [EBNF grammar][].
55-
56-
[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/
57-
[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec
58-
59-
6032
Get Involved
6133
------------
6234

‎fluent-syntax/README.md‎

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,16 @@
11
# Fluent Syntax
22

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 the low level parser, AST, and serializer APIs for the Fluent Syntax.
7-
83
[![crates.io](https://img.shields.io/crates/v/fluent-syntax.svg)](https://crates.io/crates/fluent-syntax)
94
[![docs.rs](https://img.shields.io/docsrs/fluent-syntax)](https://docs.rs/fluent-syntax)
105
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
116
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
127

13-
[Project Fluent]: https://projectfluent.org
14-
15-
Learn the FTL syntax
16-
--------------------
17-
18-
FTL is a localization file format used for describing translation resources.
19-
FTL stands for _Fluent Translation List_.
20-
21-
FTL is designed to be simple to read, but at the same time allows to represent
22-
complex concepts from natural languages like gender, plurals, conjugations, and
23-
others.
24-
25-
hello-user = Hello, { $username }!
26-
27-
[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If
28-
you're a tool author you may be interested in the formal [EBNF grammar][].
8+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
9+
a localization system designed to unleash the entire expressive power of natural language translations.
2910

30-
[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/
31-
[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec
11+
This crate exposes the low level parser, AST, and serializer APIs for the Fluent Syntax.
3212

13+
[Project Fluent]: https://projectfluent.org
3314

3415
Get Involved
3516
------------

‎fluent-testing/README.md‎

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,16 @@
11
# Fluent Testing
22

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 is a collection of mock scenarios for testing fluent-rs components.
7-
83
[![crates.io](https://img.shields.io/crates/v/fluent-bundle.svg)](https://crates.io/crates/fluent-bundle)
94
[![docs.rs](https://img.shields.io/docsrs/fluent-testing)](https://docs.rs/fluent-testing)
105
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
116
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
127

13-
Project Fluent keeps simple things simple and makes complex things possible.
14-
The syntax used for describing translations is easy to read and understand. At
15-
the same time it allows, when necessary, to represent complex concepts from
16-
natural languages like gender, plurals, conjugations, and others.
17-
18-
[Project Fluent]: https://projectfluent.org
19-
20-
Learn the FTL syntax
21-
--------------------
22-
23-
FTL is a localization file format used for describing translation resources.
24-
FTL stands for _Fluent Translation List_.
25-
26-
FTL is designed to be simple to read, but at the same time allows to represent
27-
complex concepts from natural languages like gender, plurals, conjugations, and
28-
others.
29-
30-
hello-user = Hello, { $username }!
31-
32-
[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If
33-
you're a tool author you may be interested in the formal [EBNF grammar][].
8+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
9+
a localization system designed to unleash the entire expressive power of natural language translations.
3410

35-
[Read the Fluent Syntax Guide]: https://projectfluent.org/fluent/guide/
36-
[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec
11+
This crate is a collection of mock scenarios for testing fluent-rs components.
3712

13+
[Project Fluent]: https://projectfluent.org
3814

3915
Get Involved
4016
------------

‎fluent/README.md‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,16 @@
11
# Fluent
22

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 is an umbrella that exposes the combined features of other `fluent-rs` crates with additional convenience macros.
7-
83
[![crates.io](https://img.shields.io/crates/v/fluent.svg)](https://crates.io/crates/fluent)
94
[![docs.rs](https://img.shields.io/docsrs/fluent)](https://docs.rs/fluent)
105
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
116
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
127

13-
Project Fluent keeps simple things simple and makes complex things possible.
14-
The syntax used for describing translations is easy to read and understand. At
15-
the same time it allows, when necessary, to represent complex concepts from
16-
natural languages like gender, plurals, conjugations, and others.
8+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
9+
a localization system designed to unleash the entire expressive power of natural language translations.
1710

18-
[Documentation][]
11+
This crate is an umbrella that exposes the combined features of other `fluent-rs` crates with additional convenience macros.
1912

2013
[Project Fluent]: https://projectfluent.org
21-
[Documentation]: https://docs.rs/fluent/
2214

2315
Usage
2416
-----

‎intl-memoizer/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# IntlMemoizer
22

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 memoizer specifically tailored for storing lazy-initialized intl formatters.
7-
83
[![crates.io](https://img.shields.io/crates/v/intl-memoizer.svg)](https://crates.io/crates/intl-memoizer)
94
[![docs.rs](https://img.shields.io/docsrs/intl-memoizer)](https://docs.rs/intl-memoizer)
105
[![Build](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml)
116
[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=main)](https://coveralls.io/github/projectfluent/fluent-rs?branch=main)
127

8+
The `fluent-rs` workspace is a collection of Rust crates implementing [Project Fluent][],
9+
a localization system designed to unleash the entire expressive power of natural language translations.
10+
11+
This crate provides a memoizer specifically tailored for storing lazy-initialized intl formatters.
12+
1313
[Project Fluent]: https://projectfluent.org
1414

1515
Usage

0 commit comments

Comments
 (0)