Merge pull request #227 from the94air/master

Adding 'table of Contents' to readme

Author: koalalorenzo

README.md

@@ -1,12 +1,32 @@
-# python-digitalocean
-
-This library provides easy access to Digital Ocean APIs to deploy droplets, images and more.
-
-[![](https://travis-ci.org/koalalorenzo/python-digitalocean.svg)](https://travis-ci.org/koalalorenzo/python-digitalocean)
-
-[![](https://img.shields.io/github/forks/badges/shields.svg?style=social&label=Fork)](https://travis-ci.org/koalalorenzo/python-digitalocean)
-[![](https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star)](https://travis-ci.org/koalalorenzo/python-digitalocean)
-[![](https://img.shields.io/github/watchers/badges/shields.svg?style=social&label=Watch)](https://travis-ci.org/koalalorenzo/python-digitalocean)
+<h1 align="center">python-digitalocean</h1>
+<p align="center">Easy access to Digital Ocean APIs to deploy droplets, images and more.</p>
+
+<p align="center">
+<a href="https://travis-ci.org/koalalorenzo/python-digitalocean"><img src="https://travis-ci.org/koalalorenzo/python-digitalocean.svg" alt="Build Status"></a>
+<a href="https://travis-ci.org/koalalorenzo/python-digitalocean"><img src="https://img.shields.io/github/forks/badges/shields.svg?style=social&label=Fork"></a>
+<a href="https://travis-ci.org/koalalorenzo/python-digitalocean"><img src="https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star"></a>
+<a href="https://travis-ci.org/koalalorenzo/python-digitalocean"><img src="https://img.shields.io/github/watchers/badges/shields.svg?style=social&label=Watch"></a>
+</p>
+
+## Table of Contents
+
+- [How to install](#how-to-install)
+- [Features](#features)  
+- [Examples](#examples)
+   - [Listing the droplets](#listing-the-droplets)
+   - [Listing the droplets by tags](#listing-the-droplets-by-tags)
+   - [Add a tag to a droplet](#add-a-tag-to-a-droplet)
+   - [Shutdown all droplets](#shutdown-all-droplets)
+   - [Creating a Droplet and checking its status](#creating-a-droplet-and-checking-its-status)
+   - [Checking the status of the droplet](#checking-the-status-of-the-droplet)
+   - [Add SSHKey into DigitalOcean Account](#add-sshkey-into-digitalocean-account)
+   - [Creating a new droplet with all your SSH keys](#creating-a-new-droplet-with-all-your-ssh-keys)
+   - [Creating a Firewall](#creating-a-firewall)
+- [Getting account requests/hour limits status](#getting-account-requests-hour-limits-status)
+- [Testing](#testing)
+   - [Test using Docker](#test-using-docker)
+   - [Testing using pytest manually](#testing-using-pytest-manually)
+- [Links](#links)
 
 ## How to install
 
@@ -18,6 +38,8 @@ or via sources:
 
     python setup.py install
 
+**[⬆ back to top](#table-of-contents)**
+
 ## Features
 python-digitalocean support all the features provided via digitalocean.com APIs, such as:
 
@@ -34,8 +56,9 @@ python-digitalocean support all the features provided via digitalocean.com APIs,
 * Enable/Disable automatic Backups
 * Restore root password of a Droplet
 
+**[⬆ back to top](#table-of-contents)**
 
-## Examples
+## Examples
 ### Listing the droplets
 
 This example shows how to list all the active droplets:
@@ -47,6 +70,8 @@ my_droplets = manager.get_all_droplets()
 print(my_droplets)
 ```
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Listing the droplets by tags
 
 This example shows how to list all the active droplets:
@@ -58,6 +83,8 @@ my_droplets = manager.get_all_droplets(tag_name="awesome")
 print(my_droplets)
 ```
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Add a tag to a droplet
 
 This example shows how to list all the active droplets:
@@ -69,6 +96,8 @@ tag.create() # create tag if not already created
 tag.add_droplets(["DROPLET_ID"])
 ```
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Shutdown all droplets
 
 This example shows how to shutdown all the active droplets:
@@ -81,6 +110,8 @@ for droplet in my_droplets:
     droplet.shutdown()
 ```
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Creating a Droplet and checking its status
 
 This example shows how to create a droplet and how to check its status
@@ -96,6 +127,8 @@ droplet = digitalocean.Droplet(token="secretspecialuniquesnowflake",
 droplet.create()
 ```
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Checking the status of the droplet
 ```python
 actions = droplet.get_actions()
@@ -105,6 +138,8 @@ for action in actions:
     print action.status
 ```
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Add SSHKey into DigitalOcean Account
 ```python
 from digitalocean import SSHKey
@@ -116,6 +151,8 @@ key = SSHKey(token='secretspecialuniquesnowflake',
 key.create()
 ```
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Creating a new droplet with all your SSH keys
 ```python
 manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
@@ -131,6 +168,8 @@ droplet = digitalocean.Droplet(token="secretspecialuniquesnowflake",
 droplet.create()
 ```
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Creating a Firewall
 
 This example creates a firewall that only accepts inbound tcp traffic on port 80 from a specific load balancer and allows outbout tcp traffic on all ports to all addresses.
@@ -161,7 +200,10 @@ firewall = Firewall(token="secretspecialuniquesnowflake",
 firewall.create()
 ```
 
-## Getting account requests/hour limits status:
+**[⬆ back to top](#table-of-contents)**
+
+## Getting account requests/hour limits status
+
 Each request will also include the rate limit information:
 
 ```python
@@ -196,6 +238,7 @@ domains = manager.get_all_domains()
 print(manager.ratelimit_limit) 
 ```
 
+**[⬆ back to top](#table-of-contents)**
 
 ## Testing
 
@@ -210,6 +253,8 @@ Then you can run all the tests (for both python 2 and python 3)
 
 **Note**: This will use Ubuntu 14.04 as base and use your repository to run tests. So every time you edit some files, please run these commands to perform tests on your changes.
 
+**[⬆ back to top](#table-of-contents)**
+
 ### Testing using pytest manually
 Use [pytest](http://pytest.org/) to perform testing. It is recommended to use a dedicated virtualenv to perform tests, using these commands:
 
@@ -221,10 +266,13 @@ To run all the tests manually use py.test command:
 
     $ python -m pytest
 
+**[⬆ back to top](#table-of-contents)**
 
 ## Links
 
   * GitHub: [https://github.com/koalalorenzo/python-digitalocean](https://github.com/koalalorenzo/python-digitalocean)
   * PyPI page: [https://pypi.python.org/pypi/python-digitalocean/](https://pypi.python.org/pypi/python-digitalocean/)
   * Author Website: [http://who.is.lorenzo.setale.me/?](http://setale.me/)
   * Author Blog: [http://blog.setale.me/](http://blog.setale.me/)
+
+**[⬆ back to top](#table-of-contents)**