From 55a829c1cda58a4ea280a0d88cfaa7ff207c0eab Mon Sep 17 00:00:00 2001 From: gordon chung Date: Wed, 4 Feb 2015 11:34:18 -0500 Subject: [PATCH] add README template apply basic README for initial release. Change-Id: I298fc02d66863a5214c5dc113ea547950d0bb356 --- README.md | 1 - README.rst | 27 ++++++++++++++++----------- 2 files changed, 16 insertions(+), 12 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 5d717f9..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# ceilometermiddleware diff --git a/README.rst b/README.rst index dd27982..48d339c 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,20 @@ -=============================== -ceilometermiddleware -=============================== +=============================================== +Middleware for OpenStack Telemetry (Ceilometer) +=============================================== -OpenStack Telemetry middleware for generating metrics +This library provides middleware modules designed to enable metric and event +data generation to be consumed by Ceilometer. -* Free software: Apache license -* Documentation: http://docs.openstack.org/developer/ceilometermiddleware -* Source: http://git.openstack.org/cgit/openstack/ceilometermiddleware -* Bugs: http://bugs.launchpad.net/ceilometer +The source is available on GitHub at: -Features --------- + http://github.com/openstack/ceilometermiddleware -* TODO +Bugs and feature requests are tracked on Launchpad at: + + https://bugs.launchpad.net/ceilometermiddleware + +For any other information, refer to the parent project, Ceilometer: + + https://github.com/openstack/ceilometer + +For information on contributing, see ``CONTRIBUTING.rst``.