[TASK] Update README.md even more.
This commit is contained in:
parent
c217b207ad
commit
d5c197f3e5
19
README.md
19
README.md
|
@ -2,22 +2,23 @@ Dashboard
|
||||||
=========
|
=========
|
||||||
|
|
||||||
This project is inspired by the (soon-to-be-shutdown) iGoogle page.
|
This project is inspired by the (soon-to-be-shutdown) iGoogle page.
|
||||||
It contains a simple static html page and some css magic to make it look a little bit better.
|
It contains a static html page and some javascript + css to make it look better.
|
||||||
(Also i have started the javascript stuff using jquery ui.)
|
This will become a node.js + couchdb driven application that you can configure and (of course) use.
|
||||||
|
|
||||||
This will later become a simple and configurable nodejs application,
|
It will be possible to create an account, login and customize/add/delete the widgets and the background images, re-arrange them and use them to organize e.g. rss-feeds, todo-lists and all kinds of things you can think of.
|
||||||
that will be extendable with all kinds of widgets like rss readers.
|
|
||||||
|
|
||||||
Getting started
|
Getting started
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
To get started with it, simply clone and call:
|
Dependencies: You will need `npm` (node.js) and `couchdb`.
|
||||||
|
|
||||||
|
To get started, simply clone this repository and call:
|
||||||
|
|
||||||
```
|
```
|
||||||
cp settings.json.template settings.json
|
cp settings.json.template settings.json # Create your own settings.json from the template
|
||||||
vi settings.json # Do not forget to configure it ;-)
|
vi settings.json # Configure it ;-)
|
||||||
npm install
|
npm install # Install node.js dependencies
|
||||||
npm start
|
npm start # Start the node.js application.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue