From c217b207ada6e3ca0e9140295bc9413b240fe3a4 Mon Sep 17 00:00:00 2001 From: Jan Philipp Timme Date: Mon, 16 Sep 2013 13:17:47 +0200 Subject: [PATCH] [TASK] Update README.md. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 684e2f0..7c95fd8 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,28 @@ It contains a simple static html page and some css magic to make it look a littl This will later become a simple and configurable nodejs application, that will be extendable with all kinds of widgets like rss readers. + +Getting started +--------------- + +To get started with it, simply clone and call: + +``` +cp settings.json.template settings.json +vi settings.json # Do not forget to configure it ;-) +npm install +npm start +``` + + +SSL +--- + +In order to use SSL, you need a (self-signed) ssl certificate. +I provide a simple shellscript to create a self-signed one: + +``` +cd snakeoil && ./generateSnakeoil.sh +``` + +Make sure to set up the cert + its private key in your `settings.json`. \ No newline at end of file