Update README.rst file

Change-Id: I9f6434f26019bcfd914c0b6725ac00ee4aefa6bd

README.rst

@@ -1,36 +1,98 @@
 ==========
 CloudKitty
 ==========
+|doc-status|
 
-OpenStack Rating and Usage Reporter
-+++++++++++++++++++++++++++++++++++
+Rating as a Service component
++++++++++++++++++++++++++++++
 
 Goal
 ----
 
-The goal of this project is to automate the extraction of the metrics from
-ceilometer, map them to rating informations and generate reports.
+CloudKitty aims at filling the gap between metrics collection systems like
+ceilometer and a billing system.
+
+Every metrics are collected, aggregated and processed through different rating
+modules. You can then query CloudKitty's storage to retrieve processed data and
+easily generate reports.
+
+Most parts of CloudKitty are modular so you can easily extend the base code to
+address your particular use case.
+
+You can find more information on its architecture in the documentation,
+`architecture section`_.
+
 
 Status
 ------
 
-This project is **highly** work in progress. Most of the work that we've done was
-targeted to quickly create a POC. We are now aiming towards the creation of an
-OpenStack module. Changes needed to attain our goal are huge, that's why the
-time between commits can be long.
+CloudKitty has been successfully deployed in production on different OpenStack
+systems.
 
-Roadmap
--------
-
-* Create a project API to manage the configuration of rating modules and
-  request informations.
-* Every rating module should be able to expose its own API.
-* Move from importutils to stevedore.
-* Scheduling of rating calculations
-* Better collection of ceilometer metrics (Maybe Gnocchi)
-* Global code improvement
+You can find the latest documentation on readthedocs_.
 
 
-In a possible future :
+Contributing
+------------
 
-* Spawning of instances to do the calculations
+We are welcoming new contributors, if you've got new ideas, suggestions or want
+to contribute contact us.
+
+You can reach us thought IRC (#cloudkitty @freenode.net), or on the official
+OpenStack mailing list openstack-dev@lists.openstack.org.
+
+A launchpad_ is available if you need to report bugs.
+
+
+Additional components
+---------------------
+
+We're providing an OpenStack dashboard (Horizon) integration, you can find the
+files in the cloudkitty-dashboard_ repository.
+
+A CLI is available too in the python-cloudkittyclient_ repository.
+
+
+Trying it
+---------
+
+CloudKitty can be deployed with devstack, more information can be found in the
+`devstack section`_ of the documentation.
+
+
+Deploying it in production
+--------------------------
+
+CloudKitty can be deployed in production on OpenStack Kilo environments, for
+more information check the `installation section`_ of the documentation. Due to
+oslo libraires new namespace backward compatibility is not possible. If you
+want to install it on an older system, use a virtualenv.
+
+
+.. Global references and images
+
+.. |doc-status|
+   image:: https://readthedocs.org/projects/cloudkitty/badge/?version=latest
+   :target: http://cloudkitty.readthedocs.org
+   :alt: Documentation Status
+
+
+.. _readthedocs: http://cloudkitty.readthedocs.org
+
+
+.. _launchpad: https://launchpad.net/cloudkitty
+
+
+.. _python-cloudkittyclient: https://github.com/stackforge/python-cloudkittyclient
+
+
+.. _cloudkitty-dashboard: https://github.com/stackforge/cloudkitty-dashboard
+
+
+.. _architecture section: https://cloudkitty.readthedocs.org/en/latest/arch.html
+
+
+.. _devstack section: https://cloudkitty.readthedocs.org/en/latest/devstack.html
+
+
+.. _installation section: https://cloudkitty.readthedocs.org/en/latest/installation.html