diff --git a/README.md b/README.md index 71f7b18..7e590f6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ -# local-backup-server -Nodejs server for local backups of the memex browser extension. \ No newline at end of file +Nodejs server for local backups of the memex browser extension. + +## installation +Get the newest [release](https://github.com/WorldBrain/local-backup-server/releases) for your platform. + +## rebuild & contribution +1. clone master to your local drive +2. make sure [node.js](https://nodejs.org/en/) 9 is installed on your machine +3. install the dependencies by running `npm install` +4. get the [nw.js binary](https://nwjs.io) +5. run the project by running `/path/to/nwjs-binary .` from the projects folder \ No newline at end of file