aboutsummaryrefslogtreecommitdiffstats
path: root/rst/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'rst/README.md')
-rw-r--r--rst/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/rst/README.md b/rst/README.md
new file mode 100644
index 0000000..9abd297
--- /dev/null
+++ b/rst/README.md
@@ -0,0 +1,16 @@
+`rst`
+=====
+
+Part of The [`rst`][rst] crate family.
+This crate contains the CLI:
+
+```bash
+cargo install rst
+rst README.rst
+# or
+cargo run -- README.rst
+```
+
+Maybe it will also contain a library with convenience reexports of the data structure, parser, and renderer.
+
+[rst]: https://github.com/flying-sheep/rust-rst/#readme