Add better README

jupyterhub · Jan 2, 2019 · f740552 · f740552
1 parent 803dea0
commit f740552
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 32 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,22 @@
+====================
+Jupyter Server Proxy
+====================
+
+Jupyter Server Proxy lets you run arbitrary external processes (such
+as RStudio, Shiny Server, syncthing, PostgreSQL, etc) alongside your
+notebook, and provide authenticated web access to them.
+
+The primary use cases are:
+
+#. Use with JupyterHub / Binder to allow launching users into web
+   interfaces that have nothing to do with Jupyter - such as RStudio,
+   Shiny, or OpenRefine.
+#. Allow access from frontend javascript (in classic notebook or
+   JupyterLab extensions) to access web APIs of other processes
+   running locally in a safe manner. This is used by the `JupyterLab
+   extension <https://github.com/dask/dask-labextension>`_ for 
+   `dask <https://dask.org/>`_.
+
+
+`The documentation <https://jupyter-server-proxy.readthedocs.io/>`_
+contains information on installation & usage.