[TASK] Update README.md.

This commit is contained in:
Jan Philipp Timme 2013-09-16 13:17:47 +02:00
parent d11a047068
commit c217b207ad

View File

@ -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`.