Skip to content

Commit b504168

Browse files
stasmstasm
authored
Remove Learn More from package-specific READMEs (#492)
1 parent 0b9e3d2 commit b504168

File tree

8 files changed

+33
-108
lines changed

8 files changed

+33
-108
lines changed

‎fluent-bundle/README.md‎

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# @fluent/bundle ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/bundle/badge.svg)
22

3-
`@fluent/bundle` is a JavaScript implementation of Project Fluent, a
4-
localization framework designed to unleash the expressive power of the
5-
natural language.
3+
`@fluent/bundle` is a JavaScript implementation of [Project Fluent][],
4+
optimized for runtime performance.
5+
6+
[Project Fluent]: https://projectfluent.org
67

78

89
## Installation
@@ -63,13 +64,3 @@ See also the [Compatibility][] article on the `fluent.js` wiki.
6364

6465
[intl-pluralrules]: https://www.npmjs.com/package/intl-pluralrules
6566
[Compatibility]: https://github.com/projectfluent/fluent.js/wiki/Compatibility
66-
67-
68-
## Learn more
69-
70-
Find out more about Project Fluent at [projectfluent.org][], including
71-
documentation of the Fluent file format ([FTL][]), links to other packages and
72-
implementations, and information about how to get involved.
73-
74-
[projectfluent.org]: https://projectfluent.org
75-
[FTL]: https://projectfluent.org/fluent/guide/

‎fluent-dedent/README.md‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# @fluent/dedent ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/dedent/badge.svg)
22

3-
`@fluent/dedent` provides a template literal tag to dedent Fluent code.
3+
`@fluent/dedent` provides a template literal tag to dedent Fluent code. It's
4+
part of [Project Fluent][].
5+
46
Fluent Syntax is indentation-sensitive, and `@fluent/dedent` offers a
57
convenient way to include Fluent snippets in source code keeping the current
68
level of indentation and without compromising the readability.
79

10+
[Project Fluent]: https://projectfluent.org
11+
812

913
## Installation
1014

@@ -74,13 +78,3 @@ let message = ftl`
7478

7579
assert(message === "\nhello = Hello, world!\n");
7680
```
77-
78-
79-
## Learn more
80-
81-
Find out more about Project Fluent at [projectfluent.org][], including
82-
documentation of the Fluent file format ([FTL][]), links to other packages and
83-
implementations, and information about how to get involved.
84-
85-
[projectfluent.org]: https://projectfluent.org
86-
[FTL]: https://projectfluent.org/fluent/guide/

‎fluent-dom/README.md‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# @fluent/dom ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/dom/badge.svg)
22

3-
`@fluent/dom` provides DOM bindings for Project Fluent, a localization
4-
framework designed to unleash the expressive power of the natural language.
3+
`@fluent/dom` provides the DOM bindings for [Project Fluent][].
4+
5+
[Project Fluent]: https://projectfluent.org
6+
57

68
## Installation
79

@@ -62,13 +64,3 @@ async function main() {
6264
// → 'Welcome, Anna!'
6365
}
6466
```
65-
66-
## Learn more
67-
68-
Find out more about Project Fluent at [projectfluent.org][], including
69-
documentation of the Fluent file format ([FTL][]), links to other packages and
70-
implementations, and information about how to get involved.
71-
72-
73-
[projectfluent.org]: https://projectfluent.org
74-
[FTL]: https://projectfluent.org/fluent/guide/

‎fluent-gecko/README.md‎

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,13 @@
11
# fluent-gecko ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/gecko/badge.svg)
22

3-
`fluent-gecko` is a Gecko-compatible distribution of Project Fluent,
4-
a localization framework designed to unleash the expressive power of the
5-
natural language.
3+
`fluent-gecko` is a Gecko-compatible distribution of [Project Fluent][].
64

5+
[Project Fluent]: https://projectfluent.org
76

8-
## How to use
9-
10-
The `fluent-gecko` build system produces `*.jsm` files which are ready to be
11-
used as Gecko modules.
12-
13-
`Fluent.jsm` exports the `FluentBundle` constructor which provides the
14-
core functionality of formatting translations from FTL files. See the
15-
[README][] of the main `fluent` package for more information.
167

8+
## How to use
179

18-
## Learn more
19-
20-
Find out more about Project Fluent at [projectfluent.org][], including
21-
documentation of the Fluent file format ([FTL][]), links to other packages and
22-
implementations, and information about how to get involved.
23-
10+
`fluent-gecko` can build files ready for vendoring into `mozilla-central`.
2411

25-
[README]: ../fluent/README.md
26-
[projectfluent.org]: https://projectfluent.org
27-
[FTL]: https://projectfluent.org/fluent/guide/
12+
- [`FluentSyntax.jsm`](https://searchfox.org/mozilla-central/source/intl/l10n/FluentSyntax.jsm)
13+
- [`fluent-react.js`](https://searchfox.org/mozilla-central/source/devtools/client/shared/vendor/fluent-react.js)

‎fluent-langneg/README.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# @fluent/langneg ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/langneg/badge.svg)
22

3-
`@fluent/langneg` is an API for negotiating languages. It's part of Project
4-
Fluent, a localization framework designed to unleash the expressive power of
5-
the natural language.
6-
7-
It's main function is to provide functionality around the [Intl.Locale][] API
8-
with a focus on language negotiation, matching and selection.
3+
`@fluent/langneg` provides an API for negotiating languages. It's part of
4+
[Project Fluent][]. Its main function is to provide functionality around the
5+
[Intl.Locale][] API with a focus on language negotiation, matching and
6+
selection.
97

8+
[Project Fluent]: https://projectfluent.org
109
[Intl.Locale]: https://github.com/tc39/proposal-intl-locale
1110

1211

@@ -89,12 +88,3 @@ in case the requested locale is too generic.
8988

9089
An example of that scenario is when the user requests `en` locale, and
9190
the application supports `en-GB` and `en-US`.
92-
93-
## Learn more
94-
95-
Find out more about Project Fluent at [projectfluent.org][], including
96-
documentation of the Fluent file format ([FTL][]), links to other packages and
97-
implementations, and information about how to get involved.
98-
99-
[projectfluent.org]: https://projectfluent.org
100-
[FTL]: https://projectfluent.org/fluent/guide/

‎fluent-react/README.md‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# @fluent/react ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/react/badge.svg)
22

3-
`@fluent/react` provides React bindings for Project Fluent, a localization
4-
framework designed to unleash the expressive power of the natural language.
3+
`@fluent/react` provides the React bindings for [Project Fluent][].
4+
5+
[Project Fluent]: https://projectfluent.org
56

67

78
## Installation
@@ -31,13 +32,3 @@ Consult the [wiki][] for documentation on how to set up and use
3132
The API reference is available at https://projectfluent.org/fluent.js/react.
3233

3334
[wiki]: https://github.com/projectfluent/fluent.js/wiki/React-Bindings
34-
35-
36-
## Learn more
37-
38-
Find out more about Project Fluent at [projectfluent.org][], including
39-
documentation of the Fluent file format ([FTL][]), links to other packages and
40-
implementations, and information about how to get involved.
41-
42-
[projectfluent.org]: https://projectfluent.org
43-
[FTL]: https://projectfluent.org/fluent/guide/

‎fluent-sequence/README.md‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
`@fluent/sequence` provides mapping functions from string identifiers to
44
`FluentBundle` instances taken from synchronous or asynchronous sequences.
5-
It's part of Project Fluent, a localization framework designed to unleash the
6-
expressive power of the natural language.
5+
It's part of [Project Fluent][].
6+
7+
[Project Fluent]: https://projectfluent.org
78

89

910
## Installation
@@ -56,13 +57,3 @@ The API reference is available at
5657
https://projectfluent.org/fluent.js/sequence.
5758

5859
[`cached-iterable`]: https://www.npmjs.com/package/cached-iterable
59-
60-
61-
## Learn more
62-
63-
Find out more about Project Fluent at [projectfluent.org][], including
64-
documentation of the Fluent file format ([FTL][]), links to other packages and
65-
implementations, and information about how to get involved.
66-
67-
[projectfluent.org]: https://projectfluent.org
68-
[FTL]: https://projectfluent.org/fluent/guide/

‎fluent-syntax/README.md‎

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# @fluent/syntax ![](https://github.com/projectfluent/fluent.js/workflows/@fluent/syntax/badge.svg)
22

3-
`@fluent/syntax` is a parser for Fluent translation files, FTL. Project
4-
Fluent is a localization framework designed to unleash the expressive power
5-
of the natural language.
3+
`@fluent/syntax` is a tooling library for parsing, serializing, and working
4+
with the Fluent syntax. It's part of [Project Fluent][].
65

6+
[Project Fluent]: https://projectfluent.org
77

88
## Installation
99

@@ -28,13 +28,3 @@ assert(res instanceof Resource);
2828
```
2929

3030
The API reference is available at https://projectfluent.org/fluent.js/syntax.
31-
32-
33-
## Learn more
34-
35-
Find out more about Project Fluent at [projectfluent.org][], including
36-
documentation of the Fluent file format ([FTL][]), links to other packages and
37-
implementations, and information about how to get involved.
38-
39-
[projectfluent.org]: https://projectfluent.org
40-
[FTL]: https://projectfluent.org/fluent/guide/

0 commit comments

Comments
 (0)