From bbcca7781235148e89d5b1a5f6dd2373d7eb66c2 Mon Sep 17 00:00:00 2001 From: Craig Mulligan Date: Thu, 31 Mar 2016 13:50:19 +0100 Subject: [PATCH] Add intro align with current resin.io docs Resin.io docs are pulling this file when ever they are updated to keep official docs site in sync. So need to add intro paragraph to give context. --- docs/API.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/API.md b/docs/API.md index d4302702..ffbc21f4 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,3 +1,11 @@ +# Interacting with the Resin Supervisor + +The Resin Supervisor is resin.io's agent that runs on devices. Its main role is to ensure your app is running, and keep communications with the Resin API server. + +The Supervisor itself has its own API, with means for user applications to communicate and execute some special actions that affect the host OS or the application itself. There are two main ways for the application to interact with the Supervisor: the update lockfile and the HTTP API. + +Only Supervisors after version 1.1.0 have all of this functionality. This corresponds to OS images downloaded after October 14th 2015. + ## HTTP API reference The supervisor exposes an HTTP API on port 48484 (`RESIN_SUPERVISOR_PORT`).