Add ReadMe detailing the BottleRock interface

1 files changed, 17 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9edd0f9
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+# BottleRock Interface
+
+BottleRock, by default, is hosted on port 8080. It has the following endpoints
+
+    /repo_update
+        Method: POST
+        Body:   Takes a form containing the arg repo_name
+        Example:
+            curl -X POST -F repo_name=SomeRepo http://localhost:8080/repo_update
+
+    /definitions_update 
+        Method: POST
+        Not yet implemented.
+
+    /build_complete
+        Method: POST
+        Not yet implemented.