docs: Add badges and links to crate-specific documentation

projectfluent · May 27, 2024 · 3a4cd79 · 3a4cd79
1 parent ec44980
commit 3a4cd79
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
-# 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
+
+[![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.
@@ -7,35 +10,59 @@ a localization system designed to unleash the entire expressive power of natural
 
 This workspace contains the following crates:
 
-### fluent [![crates.io](https://img.shields.io/crates/v/fluent.svg)](https://crates.io/crates/fluent)
+### fluent
+
+[![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)
 
 An umbrella crate exposing the combined features of fluent-rs crates with additional convenience macros.
 
-### fluent-bundle [![crates.io](https://img.shields.io/crates/v/fluent_bundle.svg)](https://crates.io/crates/fluent_bundle)
+### fluent-bundle
+
+[![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)
 
 A low level implementation of a collection of localization messages for a single locale.
 
-### fluent-fallback [![crates.io](https://img.shields.io/crates/v/fluent_fallback.svg)](https://crates.io/crates/fluent_fallback)
+### fluent-fallback
+
+[![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)
 
 A high-level abstraction model for managing locale bundles and runtime localization lifecycle.
 
-### fluent-resmgr [![crates.io](https://img.shields.io/crates/v/fluent_resmgr.svg)](https://crates.io/crates/fluent_resmgr)
+### fluent-resmgr
+
+[![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)
 
 A standalone solution for managing localization resource files and returning locale bundles.
 
-### fluent-syntax [![crates.io](https://img.shields.io/crates/v/fluent_syntax.svg)](https://crates.io/crates/fluent_syntax)
+### 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)
 
 The low level parser, AST, and serializer APIs for the Fluent Syntax.
 
-### fluent-pseudo [![crates.io](https://img.shields.io/crates/v/fluent_pseudo.svg)](https://crates.io/crates/fluent_pseudo)
+### fluent-pseudo
+
+[![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)
 
 A pseudolocalization and transformation API.
 
-### fluent-testing [![crates.io](https://img.shields.io/crates/v/fluent_testing.svg)](https://crates.io/crates/fluent_testing)
+### fluent-testing
+
+[![crates.io](https://img.shields.io/crates/v/fluent_testing.svg)](https://crates.io/crates/fluent_testing)
+[![docs.rs](https://img.shields.io/docsrs/fluent-testing)](https://docs.rs/fluent-testing)
 
 A collection of mock scenarios for testing fluent-rs components.
 
-### intl-memoizer [![crates.io](https://img.shields.io/crates/v/fluent_testing.svg)](https://crates.io/crates/fluent_testing)
+### intl-memoizer
+
+[![crates.io](https://img.shields.io/crates/v/fluent_testing.svg)](https://crates.io/crates/fluent_testing)
+[![docs.rs](https://img.shields.io/docsrs/intl-memoizer)](https://docs.rs/intl-memoizer)
 
 A memoizer specifically tailored for storing lazy-initialized intl formatters.
 

diff --git a/fluent-bundle/README.md b/fluent-bundle/README.md
@@ -6,6 +6,7 @@ a localization system designed to unleash the entire expressive power of natural
 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)
 

diff --git a/fluent-fallback/README.md b/fluent-fallback/README.md
@@ -6,6 +6,7 @@ a localization system designed to unleash the entire expressive power of natural
 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)
 

diff --git a/fluent-pseudo/README.md b/fluent-pseudo/README.md
@@ -6,6 +6,7 @@ a localization system designed to unleash the entire expressive power of natural
 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)
 

diff --git a/fluent-resmgr/README.md b/fluent-resmgr/README.md
@@ -6,6 +6,7 @@ a localization system designed to unleash the entire expressive power of natural
 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)
 

diff --git a/fluent-syntax/README.md b/fluent-syntax/README.md
@@ -6,6 +6,7 @@ a localization system designed to unleash the entire expressive power of natural
 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)
 

diff --git a/fluent-testing/README.md b/fluent-testing/README.md
@@ -6,6 +6,7 @@ a localization system designed to unleash the entire expressive power of natural
 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)
 

diff --git a/fluent/README.md b/fluent/README.md
@@ -6,6 +6,7 @@ a localization system designed to unleash the entire expressive power of natural
 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)
 

diff --git a/intl-memoizer/README.md b/intl-memoizer/README.md
@@ -6,6 +6,7 @@ a localization system designed to unleash the entire expressive power of natural
 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)