docs and readme in one file

maximdanilchenko · Aug 22, 2018 · b3d8303 · b3d8303
1 parent d2695e1
commit b3d8303
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -3,12 +3,12 @@
 [![Documentation Status](https://readthedocs.org/projects/async-pq/badge/?version=latest)](https://async-pq.readthedocs.io/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/maximdanilchenko/async-pq/branch/master/graph/badge.svg)](https://codecov.io/gh/maximdanilchenko/async-pq)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-# Install
+## Install
 ```
 > pip install async-pq
 ```
 
-# Usage
+## Quick start
 
 To work with ```async-pq``` we need ```asyncpg``` library:
 ```python
@@ -26,7 +26,7 @@ from async_pq import Queue, QueueFabric
 
 queue: Queue = await QueueFabric(conn).find_queue('items')
 ```
-### Operations with queue
+## Operations with queue
 Put new items (dumped JSONs) in queue:
 ```python
 await queue.put('{"id":1,"data":[1,2,3]}', '{"id":2,"data":[3,2,6]}')

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+Welcome to ```async-pq``` documentation site!
+
+[Quick start and methods references](./README)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,3 +1,6 @@
 site_name: async-pq
 theme: readthedocs
-repo_url: https://github.com/maximdanilchenko/async-pq
+repo_url: https://github.com/maximdanilchenko/async-pq
+pages:
+  - Home: index.md
+  - Usage: README.md