aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Dirkjan Ochtman <dirkjan@ochtman.nl>2017-03-08 20:33:55 +0100
committerLibravatar Dirkjan Ochtman <dirkjan@ochtman.nl>2017-03-08 20:33:55 +0100
commite558318dd2e4f7a5c13d91209cdf4a0051e9a670 (patch)
tree7fff212a3587873e186b52711c52297f5a9439bb /README.md
parent39ec850b4a141c5750e4431ac09b776b42eefb8f (diff)
downloadaskama-e558318dd2e4f7a5c13d91209cdf4a0051e9a670.tar.gz
askama-e558318dd2e4f7a5c13d91209cdf4a0051e9a670.tar.bz2
askama-e558318dd2e4f7a5c13d91209cdf4a0051e9a670.zip
Improve feature documentation in README and docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index f842d2c..24c4a13 100644
--- a/README.md
+++ b/README.md
@@ -12,16 +12,26 @@ See below for an example, or read [the documentation][docs].
**"Pretty exciting. I would love to use this already."** --
[Armin Ronacher][mitsuhiko], creator of Jinja
-Currently implemented features:
+### Feature highlights
+
+* Construct templates using a familiar, easy-to-use syntax
+* Benefit from the safety provided by Rust's type system
+* Template code is compiled into your crate for optimal performance
+* Templates only convert your data as needed
+* Templates can access your Rust types directly, according to Rust's
+ privacy rules
+* Debugging features to assist you in template development
+* Templates must be valid UTF-8 and produce UTF-8 when rendered
+* Works on stable Rust
+
+### Supported in templates
-* Generates fully type-safe Rust code from your templates
* Template inheritance
* Basic loops and if/else if/else statements
* Whitespace suppressing with '-' markers
* Some built-in filters
-* Works on stable Rust
-Askama is in heavy development, so it currently has some limitations:
+It's still early for Askama, so there are some limitations:
* Only a small number of built-in template filters have been implemented
* User-defined template filters are not supported yet