aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-08-16 18:57:09 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-08-16 18:57:09 +0200
commit288735bc2e3eb8a32a93a0d60351f96daa108c51 (patch)
treeed0ea47a5921be41a2320d34ecf0eb3a566ee507
parent9e157f453ae674a9f86601142fde91b85485883a (diff)
downloadmarkdown-rs-288735bc2e3eb8a32a93a0d60351f96daa108c51.tar.gz
markdown-rs-288735bc2e3eb8a32a93a0d60351f96daa108c51.tar.bz2
markdown-rs-288735bc2e3eb8a32a93a0d60351f96daa108c51.zip
Add a small intro to the readme
-rw-r--r--readme.md10
1 files changed, 8 insertions, 2 deletions
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/