From 288735bc2e3eb8a32a93a0d60351f96daa108c51 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Tue, 16 Aug 2022 18:57:09 +0200 Subject: Add a small intro to the readme --- readme.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index dc7e30f..4143e39 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,10 @@ # micromark-rs -Crate docs are currently at -[`wooorm.com/micromark-rs/micromark/`](https://wooorm.com/micromark-rs/micromark/). +A [CommonMark][] compliant, `no_std` + `alloc`, markdown parser, with extensions, +in Rust. + +Crate docs currently at +[`wooorm.com/micromark-rs/micromark/`][docs]. ## To do @@ -104,3 +107,6 @@ cargo doc --document-private-items ``` (add `--open` to open them in a browser) + +[commonmark]: https://spec.commonmark.org +[docs]: https://wooorm.com/micromark-rs/micromark/ -- cgit