From a1321859309051f8d34d651c9f754cd821a4b5e4 Mon Sep 17 00:00:00 2001 From: Antelle Date: Sun, 25 Oct 2015 11:25:48 +0300 Subject: [PATCH] readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 155d2d88..b89600f2 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,19 @@ It can be run either in browser, or as a desktop app. # Status Reading and display is mostly complete; modification and sync is under construction, please see [TODO](TODO.md) for more details. + +# Building + +The app is build with grunt: `grunt` (html file will be in `dist/`) or `grunt watch` (result will be in `tmp/`). +Electron app is built manually, scripts and configs are in `util` directory. +To run Electron app without building, instapp electron package (`npm install electron-prebuilt -g`) and start with `electron ./electron/`. + +# Contributing + +Plugins are not supported for now. If you want to add a feature, please contact the author first. Pull requests, patches and issues are very welcome. +If you have found an bug, please [open an issue](https://github.com/antelle/keeweb/issues/new) and fill in the app version and your user-agent +(you can find these details on Settings/Help section). + +# License + +[MIT](https://github.com/antelle/keeweb/blob/master/MIT-LICENSE.txt)