Move REST API to it's own directory.

erikcw · Apr 22, 2016 · 84053dc · 84053dc
1 parent 1adae76
commit 84053dc
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/examples/rest/README.md b/examples/rest/README.md
@@ -0,0 +1,7 @@
+The REST API example will run on port 5000 of host 0.0.0.0 (all interfaces) and be secured by SSL (self-signed certificate).
+
+    python example/rest/rest.py
+
+To secure your API with a username and password (*highly recommended if exposing to the live internet*), set the PYCIRCULATE_USERNAME and PYCIRCULATE_PASSWORD environment variables.
+
+    PYCIRCULATE_USERNAME="myusername" PYCIRCULATE_PASSWORD="password" python examples/rest/rest.py
diff --git a/examples/rest.py → examples/rest/rest.py b/examples/rest.py → examples/rest/rest.py