summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authordaz <dazzachan@yahoo.com.au>2016-08-12 15:11:17 +1000
committerDarren Chan <dazzachan@yahoo.com.au>2016-08-29 01:27:05 +0000
commit0b37c2892690a03d9922305780d89d6fb5d84299 (patch)
treecea2cefd55ce2c43468266ee1edeb85ecb0d7b4c /README.rst
parente37ea551e96c86a9bbd71f1d030e09e8e3cc45bf (diff)
downloadceilometer-0b37c2892690a03d9922305780d89d6fb5d84299.tar.gz
Update readme file
Add project description and update links Change-Id: I404c467707dba08a15628f4a04bcc77843436cdf
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst31
1 files changed, 24 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 8cd4f6b2..fe759b9a 100644
--- a/README.rst
+++ b/README.rst
@@ -1,11 +1,28 @@
-ceilometer
==========
+Ceilometer
+==========
+
+Ceilometer is a data collection service that collects event and metering
+data by monitoring notifications sent from OpenStack services. It publishes
+collected data to various targets including data stores
+and message queues.
+
+Ceilometer is distributed under the terms of the Apache
+License, Version 2.0. The full terms and conditions of this
+license are detailed in the LICENSE file.
+
+For more information about Ceilometer APIs, see
+http://developer.openstack.org/api-ref-telemetry-v2.html
+
+Release notes are available at
+https://releases.openstack.org/teams/telemetry.html
+
+Developer documentation is available at
+http://docs.openstack.org/developer/ceilometer/
-Release notes can be read online at:
- http://docs.openstack.org/developer/ceilometer/releasenotes/index.html
+For information on how to contribute to ceilometer, see the CONTRIBUTING.rst
+file.
-Documentation for the project can be found at:
- http://docs.openstack.org/developer/ceilometer/
+The project home is at http://launchpad.net/ceilometer
-The project home is at:
- http://launchpad.net/ceilometer
+To report any ceilometer related bugs, see http://bugs.launchpad.net/ceilometer/ \ No newline at end of file