Skip to content

Commit

Permalink
Add link to our book in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kijewski committed Jun 18, 2024
1 parent aca92c3 commit 32ee14f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 }}!
```

Expand Down
2 changes: 1 addition & 1 deletion rinja/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = ".."
Expand Down
5 changes: 4 additions & 1 deletion rinja/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
//!
Expand Down

0 comments on commit 32ee14f

Please sign in to comment.