aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-13 12:33:04 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-13 12:33:04 +0200
commitcaf2c774ac8a4713e8be753e5cddb09b499dbe1c (patch)
treea2dbfb65dda887f54c62b055bc2c5092e04a2ec1
parent133d2ea00f3cdf0e665859c660cc6f7e8763c3b3 (diff)
downloadmarkdown-rs-caf2c774ac8a4713e8be753e5cddb09b499dbe1c.tar.gz
markdown-rs-caf2c774ac8a4713e8be753e5cddb09b499dbe1c.tar.bz2
markdown-rs-caf2c774ac8a4713e8be753e5cddb09b499dbe1c.zip
Add improved docs
Diffstat (limited to '')
-rw-r--r--readme.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/readme.md b/readme.md
index aeb3a9d..2ceb40e 100644
--- a/readme.md
+++ b/readme.md
@@ -8,13 +8,12 @@
# markdown-rs
-<!-- To do: enable badges when repo is public/published -->
-
-<!-- To do: link `Downloads`/`crate-badge` to `crate` instead of temporary site. -->
-
[![Build][build-badge]][build]
-[![Downloads][crate-badge]][docs]
-[![Chat][chat-badge]][chat]
+[![GitHub][repo-badge]][repo]
+[![docs.rs][docs-badge]][docs]
+[![crates.io][crate-badge]][crate]
+
+<!-- To do: coverage -->
<!-- [![Coverage][coverage-badge]][coverage] -->
@@ -332,19 +331,23 @@ Special thanks go out to:
[MIT][license] © [Titus Wormer][author]
+<!-- To do: link `docs` to `docs.rs` instead of temporary site. -->
+
[build-badge]: https://github.com/wooorm/markdown-rs/workflows/main/badge.svg
[build]: https://github.com/wooorm/markdown-rs/actions
-[crate-badge]: https://img.shields.io/crates/d/markdown.svg
+[repo-badge]: https://img.shields.io/badge/GitHub-wooorm%2Fmarkdown--rs-brightgreen
-[crate]: https://crates.io/crates/markdown
+[repo]: https://github.com/wooorm/markdown-rs
+
+[docs-badge]: https://img.shields.io/docsrs/markdown
[docs]: https://wooorm.com/markdown-rs/markdown/
-[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
+[crate-badge]: https://img.shields.io/crates/v/markdown
-[chat]: https://github.com/wooorm/markdown-rs/discussions
+[crate]: https://crates.io/crates/markdown
[commonmark]: https://spec.commonmark.org