Added READMEs

2 files changed, 19 insertions, 2 deletions

diff --git a/rst/Cargo.toml b/rst/Cargo.toml
index 3c58792..a0a288e 100644
--- a/rst/Cargo.toml
+++ b/rst/Cargo.toml
@@ -5,10 +5,11 @@ authors = ['Philipp A. <flying-sheep@web.de>']
 edition = '2018'
 description = 'a reStructuredText parser and renderer for the command line'
 license = 'MIT OR Apache-2.0'
+readme = 'README.md'
 
-documentation = 'https://flying-sheep.github.io/rust-rst'
+documentation = 'https://github.com/flying-sheep/rust-rst#readme'
 homepage = 'https://github.com/flying-sheep/rust-rst'
-repository = 'https://github.com/flying-sheep/rust-rst.git'
+repository = 'https://github.com/flying-sheep/rust-rst'
 
 [dependencies]
 rst_renderer = { path = '../renderer', version = '0.3.0' }
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