From 2634a083a58e15935ce57eb0077f736309e78aae Mon Sep 17 00:00:00 2001
From: Philipp A
Date: Wed, 8 Jan 2020 20:13:56 +0100
Subject: Added READMEs

---
 parser/Cargo.toml | 5 +++--
 parser/README.md  | 9 +++++++++
 2 files changed, 12 insertions(+), 2 deletions(-)
 create mode 100644 parser/README.md

(limited to 'parser')

diff --git a/parser/Cargo.toml b/parser/Cargo.toml
index a423fbe..f208f22 100644
--- a/parser/Cargo.toml
+++ b/parser/Cargo.toml
@@ -5,10 +5,11 @@ authors = ['Philipp A. <flying-sheep@web.de>']
 edition = '2018'
 description = 'a reStructuredText parser'
 license = 'MIT OR Apache-2.0'
+readme = 'README.md'
 
-documentation = 'https://flying-sheep.github.io/rust-rst'
+documentation = 'https://docs.rs/rst_parser'
 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]
 document_tree = { path = '../document_tree', version = '0.3.0' }
diff --git a/parser/README.md b/parser/README.md
new file mode 100644
index 0000000..81d3d16
--- /dev/null
+++ b/parser/README.md
@@ -0,0 +1,9 @@
+`rst_parser`
+============
+
+Part of the [`rst`][rst] crate family.
+Offers the functions `parse` and `parse_only`,
+which try to create a `document_tree::Document`.
+`parse` simplifies this document and resolves references before returning it.
+
+[rst]: https://github.com/flying-sheep/rust-rst/#readme
-- 
cgit v1.2.3