From 0b37c2892690a03d9922305780d89d6fb5d84299 Mon Sep 17 00:00:00 2001 From: daz Date: Fri, 12 Aug 2016 15:11:17 +1000 Subject: [PATCH] Update readme file Add project description and update links Change-Id: I404c467707dba08a15628f4a04bcc77843436cdf --- README.rst | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 8cd4f6b2ba..fe759b9a25 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,28 @@ -ceilometer +========== +Ceilometer ========== -Release notes can be read online at: - http://docs.openstack.org/developer/ceilometer/releasenotes/index.html +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. -Documentation for the project can be found at: - http://docs.openstack.org/developer/ceilometer/ +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. -The project home is at: - http://launchpad.net/ceilometer +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/ + +For information on how to contribute to ceilometer, see the CONTRIBUTING.rst +file. + +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