Markdownified README

tailhook · Sep 8, 2017 · df0d571 · df0d571
1 parent 19a868b
commit df0d571
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 11 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,7 +4,7 @@ description = """
     A whitespace- and memory-friendly template engine
 """
 license = "MIT/Apache-2.0"
-readme = "README.rst"
+readme = "README.md"
 keywords = ["template", "render", "whitespace"]
 categories = ["template-engine"]
 homepage = "http://github.com/tailhook/trimmer"

diff --git a/README.rst → README.md b/README.rst → README.md
@@ -1,22 +1,19 @@
-=======
 Trimmer
 =======
 
-:Status: Alpha
-
-Reference_ | `API Docs`_ | Crate_
+:Status: Beta
 
-.. _api docs: https://docs.rs/trimmer/
-.. _reference: https://trimmer.readthedocs.io/
-.. _crate: https://crates.io/crates/trimmer
+[Reference](https://trimmer.readthedocs.io/) |
+[API Docs](https://docs.rs/trimmer/) |
+[Crate](https://crates.io/crates/trimmer)
 
-Yet anoter template engine for Rust. Features:
+Yet another template engine for Rust. Features:
 
 * Can produce better indented text than most template engines
 * Can traverse Rust types without cloning them too much
+* Can produce safe output by validating variable values rather than escaping
 
 
-=======
 License
 =======
 
@@ -27,7 +24,6 @@ Licensed under either of
 
 at your option.
 
-------------
 Contribution
 ------------