Skip to content
Browse files

update API docs to include a Quick Start

  • Loading branch information...
1 parent f0c23f0 commit c84d1b185bcc4beb679fd2e16de33099da0f5b86 Benjamin Oakes and Zach Morek committed with ZachBeta Nov 27, 2013
Showing with 19 additions and 6 deletions.
  1. +19 −6 README.md
View
25 README.md
@@ -2,16 +2,27 @@
An example of integrating with the Continuity Control API using Sinatra + HTTParty.
-This guide assumes you have a Continuity Control API key. To obtain an API key, please visit [API Access in Control](https://control.continuity.net/settings/api_users).
-
## Quick links
-* [API documentation](http://continuitycontrol.github.io/control_api_reference/)
+* [API documentation][api_docs]
* [Change Log](ChangeLog)
* [Control](https://control.continuity.net)
-* [Sample application](http://control-api-reference.herokuapp.com/) (this code)
+* [Sample application](http://control-api-reference.herokuapp.com/) (reference implementation)
+
+## Quick Start
+
+In order to use the Continuity Control API you will need to follow the steps below:
+
+1. Set up an API key on Control. To obtain an API key, please visit [API Access in Control](https://control.continuity.net/settings/api_users).
+2. Make a request for the status of the API using your tool of choice. For example:
-## Running this code
+ curl -u $CONTROL_API_KEY:$CONTROL_API_SECRET https://api.continuity.net/v1/status
+
+3. Verify that you see a response that states the service is up
+4. Review this README and the [API documentation][api_docs] for more details on how to use all features of the API
+5. Grab a cup of coffee, you're done! :-)
+
+## Running this reference implementation
You'll need Ruby 2.0.0 installed. Please see [the Ruby installation guide for more information](https://www.ruby-lang.org/en/downloads/).
@@ -49,4 +60,6 @@ If you do not see `API status: up`, there are several possible causes:
## API documentation
-The API documentation is inline with examples in [app.rb](app.rb). There is also a [documentation website generated from the contents of that file](http://continuitycontrol.github.io/control_api_reference/).
+The API documentation is inline with examples in [app.rb](app.rb). There is also a [documentation website generated from the contents of that file][api_docs].
+
+ [api_docs]: http://continuitycontrol.github.io/control_api_reference/

0 comments on commit c84d1b1

Please sign in to comment.
Something went wrong with that request. Please try again.