From d2b7cea972245ab64c0eec32fdfbaad68e781555 Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Tue, 11 Sep 2018 10:43:40 +0200
Subject: [PATCH] Documentation

---
 README.md     | 30 ++++++++++++++++++++++++++++++
 login_example |  9 +++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 README.md
 create mode 100755 login_example

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e72589d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+Office365 OAuth2 authenticator
+==============================
+
+This project retrieves cookies used to authenticate an user on Sharepoint Online.
+
+## Requirements
+
+Tested with NodeJS 6.13.0.
+
+## Installation
+
+```
+$ git clone https://gitnet.fr/deblan/office365-oauth2-authenticator.git
+$ cd office365-oauth2-authenticator
+$ npm install
+```
+
+## Configuration
+
+```
+$ cp login_example login
+```
+
+Edit `login` and replace values of:
+
+* MS_OFFICE365_SITE
+* MS_OFFICE365_LOGIN
+* MS_OFFICE365_PASSWORD
+
+Then run `node index.js`.
diff --git a/login_example b/login_example
new file mode 100755
index 0000000..80639b9
--- /dev/null
+++ b/login_example
@@ -0,0 +1,9 @@
+#!/bin/sh
+
+# OPTIONS="--debug --crawler-debug"
+
+export MS_OFFICE365_SITE="https://foo.sharepoint.com/"
+export MS_OFFICE365_LOGIN="bar@example.com"
+export MS_OFFICE365_PASSWORD="5eCrEt"
+
+node ./index.js $OPTIONS