From 64ff45fb76d24e62140e35204f17330beee7a0c1 Mon Sep 17 00:00:00 2001
From: F483 <fabian.barkhau@gmail.com>
Date: Tue, 15 Mar 2016 23:59:32 +0100
Subject: [PATCH] added bandwidth to readme

---
 README.rst | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 717ef57..1ac86ad 100644
--- a/README.rst
+++ b/README.rst
@@ -78,7 +78,7 @@ Examples:
     GET /api/register/e61ea5a799707fb9133cc2978f4c9f37da73db88/1Mym8X3heKx1sZTDyM9z9djcRCq2g715BL
     RESPONSE:
         Status Code: 200
-        Text: Json encoded node information
+        Text: {"bandwidth_download": 0, "payout_addr": "1Mym8X3heKx1sZTDyM9z9djcRCq2g715BL", "bandwidth_upload": 0, "last_seen": 0, "height": 0, "uptime": 100.0, "nodeid": "e61ea5a799707fb9133cc2978f4c9f37da73db88", "reg_time": 1458079196, "ip": ""}
 
 +-------------+-------------------------------------+
 | Error Codes | What happened                       |
@@ -120,7 +120,6 @@ Example:
 |     404     | Farmer not found           |
 +-------------+----------------------------+
 
-
 Online Status - JSON
 ********************
 
@@ -225,6 +224,36 @@ Example:
 +-------------+----------------------------+
 
 
+Advertise bandwidth
+*******************
+
+Allows the user to let the node know how much upload and download bandwidth they have avaivable.
+
+::
+
+    GET /api/bandwidth/<nodeid>/<upload>/<download>
+
+
+Example:
+
+::
+    GET /api/bandwidth/e61ea5a799707fb9133cc2978f4c9f37da73db88/123/456
+    RESPONSE:
+        Status Code: 200
+        Text: Bandwidth accepted.
+
+
++-------------+----------------------------+
+| Error Codes | What happened              |
++=============+============================+
+|     400     | Invalid nodeid             |
++-------------+----------------------------+
+|     401     | Bad authentication headers |
++-------------+----------------------------+
+|     404     | Farmer not found           |
++-------------+----------------------------+
+
+
 Block Audit
 ***********