From bfd12a28e8ed327b391a47e6582295601a49aa23 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Benedikt=20R=C3=B6tsch?= <benedikt@contentful.com>
Date: Tue, 24 Oct 2017 17:20:23 +0200
Subject: [PATCH] docs(README): rudimentary infos for setup and deep links

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index a842819..236a199 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
 # the-example-app.js
 The Contentful example app, written in JS
+
+## Requirements
+
+* Node 8
+* Git
+
+
+## Installation
+
+```bash
+git clone --recursive https://github.com/contentful/example-contentful-university-js.git
+```
+
+```bash
+npm install
+```
+
+## Usage
+
+```
+npm start
+```
+
+Open http://localhost:3000/?enable_editorial_features in your browser.
+
+## Deep links
+
+The following deep links are supported:
+
+* `?enable_editorial_features` - Shows `Edit in web app` button on every content type plus `Draft` and `Pending Changes` status pills
+* `?space_id=xxx&delivery_access_token=xxx&preview_access_token=xxx` - Configure the connected space
+
+