From 62ef553dcb26db565d48c34710015924dbc2064c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Kijewski?= Date: Sat, 3 Aug 2024 03:31:07 +0200 Subject: [PATCH] readme: add badges --- README.md | 5 +++++ rinja/src/lib.rs | 5 +++++ rinja_actix/README.md | 7 ++++--- rinja_axum/README.md | 7 ++++--- rinja_derive/README.md | 7 ++++--- rinja_parser/README.md | 7 ++++--- rinja_rocket/README.md | 7 ++++--- rinja_warp/README.md | 7 ++++--- 8 files changed, 34 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 65daac50..0b969088 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # rinja +[![Crates.io](https://img.shields.io/crates/v/rinja?logo=rust&style=flat-square&logoColor=white "Crates.io")](https://crates.io/crates/rinja) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rinja-rs/rinja/rust.yml?branch=master&logo=github&style=flat-square&logoColor=white "GitHub Workflow Status")](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml) +[![Book](https://img.shields.io/readthedocs/rinja?label=book&logo=readthedocs&style=flat-square&logoColor=white "Book")](https://rinja.readthedocs.io/) +[![docs.rs](https://img.shields.io/docsrs/rinja?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/rinja/) + **Rinja** implements a template rendering engine based on [Jinja](https://jinja.palletsprojects.com/), and generates type-safe Rust code from your templates at compile time based on a user-defined `struct` to hold the template's context. diff --git a/rinja/src/lib.rs b/rinja/src/lib.rs index c8421246..f6032ff7 100644 --- a/rinja/src/lib.rs +++ b/rinja/src/lib.rs @@ -1,3 +1,8 @@ +//! [![Crates.io](https://img.shields.io/crates/v/rinja?logo=rust&style=flat-square&logoColor=white "Crates.io")](https://crates.io/crates/rinja) +//! [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rinja-rs/rinja/rust.yml?branch=master&logo=github&style=flat-square&logoColor=white "GitHub Workflow Status")](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml) +//! [![Book](https://img.shields.io/readthedocs/rinja?label=book&logo=readthedocs&style=flat-square&logoColor=white "Book")](https://rinja.readthedocs.io/) +//! [![docs.rs](https://img.shields.io/docsrs/rinja?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/rinja/) +//! //! Rinja implements a type-safe compiler for Jinja-like templates. //! It lets you write templates in a Jinja-like syntax, //! which are linked to a `struct` defining the template context. diff --git a/rinja_actix/README.md b/rinja_actix/README.md index 71e29242..4cff059f 100644 --- a/rinja_actix/README.md +++ b/rinja_actix/README.md @@ -1,8 +1,9 @@ # rinja_actix: Rinja integration with Actix-web -[![Documentation](https://docs.rs/rinja_actix/badge.svg)](https://docs.rs/rinja_actix/) -[![Latest version](https://img.shields.io/crates/v/rinja_actix.svg)](https://crates.io/crates/rinja_actix) -[![Build Status](https://github.com/rinja-rs/rinja/workflows/CI/badge.svg)](https://github.com/rinja-rs/rinja/actions?query=workflow%3ACI) +[![Crates.io](https://img.shields.io/crates/v/rinja_actix?logo=rust&style=flat-square&logoColor=white "Crates.io")](https://crates.io/crates/rinja_actix) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rinja-rs/rinja/rust.yml?branch=master&logo=github&style=flat-square&logoColor=white "GitHub Workflow Status")](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml) +[![Book](https://img.shields.io/readthedocs/rinja?label=book&logo=readthedocs&style=flat-square&logoColor=white "Book")](https://rinja.readthedocs.io/) +[![docs.rs](https://img.shields.io/docsrs/rinja_actix?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/rinja_actix/) Integration of the [Rinja](https://github.com/rinja-rs/rinja) templating engine in code building on the Actix-web framework. diff --git a/rinja_axum/README.md b/rinja_axum/README.md index b418c60f..f560c25a 100644 --- a/rinja_axum/README.md +++ b/rinja_axum/README.md @@ -1,8 +1,9 @@ # rinja_axum: Rinja integration with Axum -[![Documentation](https://docs.rs/rinja_axum/badge.svg)](https://docs.rs/rinja_axum/) -[![Latest version](https://img.shields.io/crates/v/rinja_axum.svg)](https://crates.io/crates/rinja_axum) -[![Build Status](https://github.com/rinja-rs/rinja/workflows/CI/badge.svg)](https://github.com/rinja-rs/rinja/actions?query=workflow%3ACI) +[![Crates.io](https://img.shields.io/crates/v/rinja_axum?logo=rust&style=flat-square&logoColor=white "Crates.io")](https://crates.io/crates/rinja_axum) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rinja-rs/rinja/rust.yml?branch=master&logo=github&style=flat-square&logoColor=white "GitHub Workflow Status")](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml) +[![Book](https://img.shields.io/readthedocs/rinja?label=book&logo=readthedocs&style=flat-square&logoColor=white "Book")](https://rinja.readthedocs.io/) +[![docs.rs](https://img.shields.io/docsrs/rinja_axum?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/rinja_axum/) Integration of the [Rinja](https://github.com/rinja-rs/rinja) templating engine in code building on the Axum web framework. diff --git a/rinja_derive/README.md b/rinja_derive/README.md index 5630c5ed..afb92f18 100644 --- a/rinja_derive/README.md +++ b/rinja_derive/README.md @@ -1,8 +1,9 @@ # rinja_derive: procedural macros for the Rinja templating engine -[![Documentation](https://docs.rs/rinja_derive/badge.svg)](https://docs.rs/rinja_derive/) -[![Latest version](https://img.shields.io/crates/v/rinja_derive.svg)](https://crates.io/crates/rinja_derive) -[![Build Status](https://github.com/rinja-rs/rinja/workflows/CI/badge.svg)](https://github.com/rinja-rs/rinja/actions?query=workflow%3ACI) +[![Crates.io](https://img.shields.io/crates/v/rinja_derive?logo=rust&style=flat-square&logoColor=white "Crates.io")](https://crates.io/crates/rinja_derive) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rinja-rs/rinja/rust.yml?branch=master&logo=github&style=flat-square&logoColor=white "GitHub Workflow Status")](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml) +[![Book](https://img.shields.io/readthedocs/rinja?label=book&logo=readthedocs&style=flat-square&logoColor=white "Book")](https://rinja.readthedocs.io/) +[![docs.rs](https://img.shields.io/docsrs/rinja_derive?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/rinja_derive/) This crate contains the procedural macros used by the [Rinja](https://github.com/rinja-rs/rinja) templating engine. diff --git a/rinja_parser/README.md b/rinja_parser/README.md index 1c3af737..1df3ed1a 100644 --- a/rinja_parser/README.md +++ b/rinja_parser/README.md @@ -1,8 +1,9 @@ # rinja_parser: template parser for the Rinja templating engine -[![Documentation](https://docs.rs/rinja_parser/badge.svg)](https://docs.rs/rinja_parser/) -[![Latest version](https://img.shields.io/crates/v/rinja_parser.svg)](https://crates.io/crates/rinja_parser) -[![Build Status](https://github.com/rinja-rs/rinja/workflows/CI/badge.svg)](https://github.com/rinja-rs/rinja/actions?query=workflow%3ACI) +[![Crates.io](https://img.shields.io/crates/v/rinja_parser?logo=rust&style=flat-square&logoColor=white "Crates.io")](https://crates.io/crates/rinja_parser) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rinja-rs/rinja/rust.yml?branch=master&logo=github&style=flat-square&logoColor=white "GitHub Workflow Status")](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml) +[![Book](https://img.shields.io/readthedocs/rinja?label=book&logo=readthedocs&style=flat-square&logoColor=white "Book")](https://rinja.readthedocs.io/) +[![docs.rs](https://img.shields.io/docsrs/rinja_parser?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/rinja_parser/) This crate contains the procedural macros used by the [Rinja](https://github.com/rinja-rs/rinja) templating engine. diff --git a/rinja_rocket/README.md b/rinja_rocket/README.md index ce4bc87d..5a39ab8c 100644 --- a/rinja_rocket/README.md +++ b/rinja_rocket/README.md @@ -1,8 +1,9 @@ # rinja_rocket: Rinja integration with Rocket -[![Documentation](https://docs.rs/rinja_rocket/badge.svg)](https://docs.rs/rinja_rocket/) -[![Latest version](https://img.shields.io/crates/v/rinja_rocket.svg)](https://crates.io/crates/rinja_rocket) -[![Build Status](https://github.com/rinja-rs/rinja/workflows/CI/badge.svg)](https://github.com/rinja-rs/rinja/actions?query=workflow%3ACI) +[![Crates.io](https://img.shields.io/crates/v/rinja_rocket?logo=rust&style=flat-square&logoColor=white "Crates.io")](https://crates.io/crates/rinja_rocket) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rinja-rs/rinja/rust.yml?branch=master&logo=github&style=flat-square&logoColor=white "GitHub Workflow Status")](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml) +[![Book](https://img.shields.io/readthedocs/rinja?label=book&logo=readthedocs&style=flat-square&logoColor=white "Book")](https://rinja.readthedocs.io/) +[![docs.rs](https://img.shields.io/docsrs/rinja_rocket?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/rinja_rocket/) Integration of the [Rinja](https://github.com/rinja-rs/rinja) templating engine in code building on the Rocket web framework. diff --git a/rinja_warp/README.md b/rinja_warp/README.md index 2671e561..ed4fefbf 100644 --- a/rinja_warp/README.md +++ b/rinja_warp/README.md @@ -1,8 +1,9 @@ # rinja_warp: Rinja integration with warp -[![Documentation](https://docs.rs/rinja_warp/badge.svg)](https://docs.rs/rinja_warp/) -[![Latest version](https://img.shields.io/crates/v/rinja_warp.svg)](https://crates.io/crates/rinja_warp) -[![Build Status](https://github.com/rinja-rs/rinja/workflows/CI/badge.svg)](https://github.com/rinja-rs/rinja/actions?query=workflow%3ACI) +[![Crates.io](https://img.shields.io/crates/v/rinja_warp?logo=rust&style=flat-square&logoColor=white "Crates.io")](https://crates.io/crates/rinja_warp) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rinja-rs/rinja/rust.yml?branch=master&logo=github&style=flat-square&logoColor=white "GitHub Workflow Status")](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml) +[![Book](https://img.shields.io/readthedocs/rinja?label=book&logo=readthedocs&style=flat-square&logoColor=white "Book")](https://rinja.readthedocs.io/) +[![docs.rs](https://img.shields.io/docsrs/rinja_warp?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/rinja_warp/) Integration of the [Rinja](https://github.com/rinja-rs/rinja) templating engine in code building on the warp web framework.