From 3a4cd79050e0a80e010597c108fc9cb26c1b2603 Mon Sep 17 00:00:00 2001 From: Caleb Maclennan Date: Mon, 27 May 2024 22:19:44 +0300 Subject: [PATCH] docs: Add badges and links to crate-specific documentation --- README.md | 45 +++++++++++++++++++++++++++++++-------- fluent-bundle/README.md | 1 + fluent-fallback/README.md | 1 + fluent-pseudo/README.md | 1 + fluent-resmgr/README.md | 1 + fluent-syntax/README.md | 1 + fluent-testing/README.md | 1 + fluent/README.md | 1 + intl-memoizer/README.md | 1 + 9 files changed, 44 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 06f6283e..c33e74fe 100644 --- 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 index b88a9be1..7922f472 100644 --- 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 index a1a21051..00e11756 100644 --- 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 index a407eee6..b043cd07 100644 --- 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 index 4e196ed1..36b4bfa8 100644 --- 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 index 45c8bdc3..221a1342 100644 --- 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 index 8a3db68d..4f322d5c 100644 --- 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 index fd0ed3eb..d8407201 100644 --- 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 index 6c275ceb..69a53d50 100644 --- 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)