From a61a0f915b25153ce46501e75d377e2fedd3d6f4 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Wed, 17 Apr 2019 10:18:14 +0800 Subject: [PATCH] Add table of contents Change-Id: I6d5ebd602380e2297735204b24f00f60c507de18 --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a054a571..e6c432ef 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,21 @@ Team and repository tags VSwitch -======= +==== + +#### Table of Contents + +1. [Overview - What is the AODH module?](#overview) +2. [Development - Guide for contributing to the module](#development) +3. [Contributors - Those with commits](#contributors) +4. [Release Notes - Release notes for the project](#release-notes) +5. [Repository - The project source code repository](#repository) +6. [Usage - The usage of the module](#usage) +7. [Beaker-Rspec - Beaker-rspec tests for the project](#beaker-rpsec) +8. [Setup - The basics of getting started with AODH](#setup) + +Overview +-------- 4.0.0 - 2016.1 - Mitaka @@ -43,7 +57,8 @@ Repository * https://git.openstack.org/cgit/openstack/puppet-vswitch -## USAGE: +Usage +------------- To create a new bridge, use the `vs_bridge` type: ``` @@ -92,7 +107,8 @@ vs_config { 'array_key': } ``` -## Beaker-Rspec +Beaker-Rspec +------------- This module has beaker-rspec tests @@ -103,7 +119,8 @@ bundle install bundle exec rspec spec/acceptance ``` -## TODO: +TODO: +------------- * OpenFlow controller settings * OpenFlow Settings * OpenFlow Tables