From ed6bf0b173492bc7fa19918489eaf1978e282a11 Mon Sep 17 00:00:00 2001
From: bill bittner <bittner.w@gmail.com>
Date: Fri, 10 Aug 2018 15:19:19 -0700
Subject: [PATCH] updated claim/availability response docs

---
 README.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6db2c201..5410dc60 100644
--- a/README.md
+++ b/README.md
@@ -105,7 +105,14 @@ example:
 ```
 curl https://spee.ch/api/claim/availability/doitlive
 ```
-returns the name if it is available
+response:
+```
+{
+    "success": <bool>,  // `true` if spee.ch succesfully checked the claim availability
+    "data": <bool>, // `true` if claim is available, false if it is not available
+    "message": <string> // human readable message of whether claim was available or not
+}
+```
 
 ## Contribute