keeweb
/
keeweb
mirror of https://github.com/keeweb/keeweb.git
1
0
Fork 0
Code Issues Releases Wiki Activity

readme

This commit is contained in:
Antelle 2015-10-25 11:25:48 +03:00
parent 0ba11712f2
commit a132185930
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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)