From 32ee14f87508548be28517051c3d2f759d4d28a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Kijewski?= Date: Tue, 18 Jun 2024 14:16:00 +0200 Subject: [PATCH] Add link to our book in README.md --- README.md | 5 ++++- rinja/Cargo.toml | 2 +- rinja/src/lib.rs | 5 ++++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bf75cf94a..682863db7 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,9 @@ See below for an example. All feedback welcome. Feel free to file bugs, requests for documentation and any other feedback to the [issue tracker][issues]. +You can find the documentation about our syntax, features, configuration in our book: +[rinja.readthedocs.io](https://rinja.readthedocs.io/en/latest/). + ### Feature highlights * Construct templates using a familiar, easy-to-use syntax @@ -44,7 +47,7 @@ cargo add rinja Now create a directory called `templates` in your crate root. In it, create a file called `hello.html`, containing the following: -``` +```jinja Hello, {{ name }}! ``` diff --git a/rinja/Cargo.toml b/rinja/Cargo.toml index 80d29c69a..59aed57f9 100644 --- a/rinja/Cargo.toml +++ b/rinja/Cargo.toml @@ -5,7 +5,7 @@ description = "Type-safe, compiled Jinja-like templates for Rust" documentation = "https://docs.rs/rinja" keywords = ["markup", "template", "jinja2", "html"] categories = ["template-engine"] -homepage = "https://github.com/rinja-rs/rinja" +homepage = "https://rinja.readthedocs.io/" repository = "https://github.com/rinja-rs/rinja" license = "MIT OR Apache-2.0" workspace = ".." diff --git a/rinja/src/lib.rs b/rinja/src/lib.rs index 0cc4966d7..38cec1759 100644 --- a/rinja/src/lib.rs +++ b/rinja/src/lib.rs @@ -5,7 +5,10 @@ //! in [`rinja_derive`](https://crates.io/crates/rinja_derive)). //! //! For feature highlights and a quick start, please review the -//! [README](https://github.com/rinja-rs/rinja/blob/main/README.md). +//! [README](https://github.com/rinja-rs/rinja/blob/master/README.md). +//! +//! You can find the documentation about our syntax, features, configuration in our book: +//! [rinja.readthedocs.io](https://rinja.readthedocs.io/en/latest/). //! //! # Creating Rinja templates //!