From db07547ecb615eeeee56c27f5a3010d1a9d53ea6 Mon Sep 17 00:00:00 2001
From: Elia El Lazkani <eliaellazkani@gmail.com>
Date: Fri, 1 Nov 2019 19:43:19 +0100
Subject: [PATCH] Adding more information to the README

---
 README.rst | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/README.rst b/README.rst
index 0ebb99b..0eb24ea 100644
--- a/README.rst
+++ b/README.rst
@@ -1,6 +1,26 @@
-shortenit
+Shortenit
 =========
 
-shortenit is a tool to shorten urls.
+Shortenit is a tool to shorten urls.
 
-NOTE: This is a very early draft project. Contributions are welcome.
+**NOTE**: This is a very early draft project. Contributions are welcome.
+
+Running
+-------
+
+To run ``shortenit``, first we need to have a running database. Shortenit uses `CouchDB <https://couchdb.apache.org/>`_ as a database.
+CouchDB can run as a docker container.
+
+.. code:: text
+
+          $ docker run -p 5984:5984 -d couchdb 
+
+
+At this point, visit the local instance `link <http://localhost:5984/>`_ and create the user credentials configured in ``config/config.py``.
+
+Once the database is up and running and the credentials have been created, shortenit can be ran.
+
+.. code:: text
+
+          $ pip install -e .
+          $ shortenit