From f7405529e5256abd6812afbb9dd53cedb2681385 Mon Sep 17 00:00:00 2001
From: yuvipanda <yuvipanda@gmail.com>
Date: Wed, 2 Jan 2019 09:06:02 -0800
Subject: [PATCH] Add better README

---
 README.md  | 32 --------------------------------
 README.rst | 22 ++++++++++++++++++++++
 2 files changed, 22 insertions(+), 32 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/README.md b/README.md
deleted file mode 100644
index bccc11e1..00000000
--- a/README.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# nbserverproxy
-Jupyter notebook server extension to proxy web services. This enables users to reach arbitrary web services running within their spawned Jupyter server and is probably most appropriate for services which can't readily be converted into extensions.
-
-## Example
-A user starts a web service via `New > Terminal`:
-```
-echo "hello world" > index.html
-python -m http.server 8001
-```
-The service is proxied off to `/proxy/` and can be reached at
-* https://address.of.notebook.server/user/theuser/proxy/8001 when running inside a JupyterHub
-* http://localhost:8888/proxy/8001 when running locally
-
-## Installation
-nbserverproxy requires python3.
-
-Install via pip:
-```
-pip install nbserverproxy
-```
-
-Or via conda:
-```
-conda install -c conda-forge nbserverproxy
-```
-
-Then enable:
-```
-jupyter serverextension enable --py nbserverproxy
-```
-
-Based on https://github.com/senko/tornado-proxy.
diff --git a/README.rst b/README.rst
new file mode 100644
index 00000000..0763b23d
--- /dev/null
+++ 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.
\ No newline at end of file