From 84e945367d1ef727b81430c223c7451e8fb6a05b Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Wed, 11 Jul 2018 10:37:05 -0700 Subject: [PATCH] Make README better - Mark develpment status clearly - Link to tutorials directly --- README.rst | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 93a1f09..e0c2e6b 100644 --- a/README.rst +++ b/README.rst @@ -22,11 +22,25 @@ libraries into this environment easily without any specialized knowledge. See `this blog post `_ for more information. -This project is currently in pre-alpha state & extremely prone to breaking! +Development Status +================== -Tutorials -========= +This project is currently in **pre-alpha**, and things will break all the time. +However, feedback at this time is extremely valuble, so you should still try +it out! -We have tutorials to help you set up The Littlest JupyterHub (TLJH) on any of the -popular providers (Google, Digital Ocean, Jetstream, etc) or on your own server. -They should take less than ten minutes to get you to a working JupyterHub! +Installation +============ + +The Littlest JupyterHub (TLJH) can run on any server that is running at least +Ubuntu 18.04. We have a bunch of tutorials to get you started! + +- `Tutorial for installing TLJH on your own server that is already running. + `_ +- Tutorials for creating a new server & setting up TLJH on it in various + cloud providers: + + - `Digital Ocean `_ + - `Google Cloud `_ + - `Jetstream `_ + - ... more, if you add them! :)