From e9d541739f3a725f7980677d4b97b6fede621506 Mon Sep 17 00:00:00 2001 From: Rick Carlino Date: Wed, 7 Dec 2016 13:27:46 -0600 Subject: [PATCH] README update. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e79bfd4dc..a0036877c 100755 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ This Repo is RESTful JSON API for Farmbot. This includes things like storage of The key responsibility of the API is *information and permissions management*. This should not be confused with device control, which is done via [MQTT](https://github.com/FarmBot/mqtt-gateway). +# API Documentation + +For a list of example API requests and responses, see our [reference documentation](https://gist.github.com/RickCarlino/5f3d885e88d6e15b2ffe1763cc2a750a). + # Developer Setup ## Prerequisites @@ -23,7 +27,7 @@ Your machine will need the following: 0. [Ruby 2.3.2](http://rvm.io/rvm/install) -## Setup +### Setup 0. `git clone https://github.com/FarmBot/Farmbot-Web-API farmbot-web-app` 0. `cd farmbot-web-app` 0. `bundle install`