From ddf90041118f9b4dae7d1be9db691c910f2dd80a Mon Sep 17 00:00:00 2001
From: Nataliia Uvarova <grafinya.uvarova@gmail.com>
Date: Thu, 13 Mar 2014 10:18:46 +0100
Subject: [PATCH] Improve README file

Fix curl command example, add link to wiki and section about tests.

Change-Id: I7033cf3e281d0738a8b11f6b81afd900eebb81fd
---
 README.rst                  | 29 ++++++++++++++++++++++++-----
 tests/functional/README.rst |  2 +-
 2 files changed, 25 insertions(+), 6 deletions(-)

diff --git a/README.rst b/README.rst
index 9e9970f03..291422ec9 100644
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,8 @@
 Marconi
 =======
 
-Message queuing service for `OpenStack`_
+Message queuing service for `OpenStack`_.
+To find more information read our `wiki`_.
 
 Running a local Marconi server with MongoDB
 -------------------------------------------
@@ -21,9 +22,13 @@ installed and running.
     $ cp marconi/etc/marconi.conf-sample ~/.marconi/marconi.conf
     $ cp marconi/etc/logging.conf-sample ~/.marconi/logging.conf
 
-3. Find the ``[drivers:storage:mongodb]`` section in
-   ``~/.marconi/marconi.conf`` and modify the URI to point
-   to your local mongod instance::
+3. Find ``[drivers]`` section in ``~/.marconi/marconi.conf``
+   and specify to use mongodb storage::
+
+    storage = mongodb
+
+   Then find the ``[drivers:storage:mongodb]`` section
+   and modify the URI to point to your local mongod instance::
 
     uri = mongodb://$MONGODB_HOST:$MONGODB_PORT
 
@@ -49,7 +54,7 @@ installed and running.
 8. Test out that Marconi is working by creating a queue::
 
     $ curl -i -X PUT http://127.0.0.1:8888/v1/queues/samplequeue -H
-    "Content-type: application/json" -d '{"metadata": "Sample Queue"}'
+    "Content-type: application/json"
 
 You should get an **HTTP 201** along with some headers that will look
 similar to this::
@@ -60,9 +65,23 @@ similar to this::
     Content-Length: 0
     Location: /v1/queues/samplequeue
 
+Running tests
+-------------
+
+First install additional requirements::
+
+    pip install tox
+
+And then run tests::
+
+    tox -e py27
+
+You can read more about running functional tests in separate `TESTS_README`_.
 
 .. _`OpenStack` : http://openstack.org/
 .. _`MongoDB` : http://docs.mongodb.org/manual/installation/
 .. _`pyenv` : https://github.com/yyuu/pyenv/
 .. _`virtualenv` : https://pypi.python.org/pypi/virtualenv/
+.. _`wiki` : https://wiki.openstack.org/wiki/Marconi/
+.. _`TESTS_README` : https://github.com/openstack/marconi/blob/master/tests/functional/README.rst
 
diff --git a/tests/functional/README.rst b/tests/functional/README.rst
index 118732ce3..e689ce633 100644
--- a/tests/functional/README.rst
+++ b/tests/functional/README.rst
@@ -66,5 +66,5 @@ Adding New Tests
     messages/test_messages.py
     claim/test_claims.py
 
-.. _README : https://github.com/stackforge/marconi/blob/master/README.rst
+.. _README : https://github.com/openstack/marconi/blob/master/README.rst
 .. _requests : https://pypi.python.org/pypi/requests