added specifics about contents to the readme

This commit is contained in:
tigerbot 2017-04-21 17:26:10 -06:00
parent 6a03ceb011
commit 8198db872e
1 changed files with 21 additions and 4 deletions

View File

@ -1,13 +1,30 @@
Example of a simple `Electon` app that uses the features described as
["sexy" by the webtorrent team](https://blog.dcpos.ch/how-to-make-your-electron-app-sexy).
# Electron Demo
Example of a simple `Electon` app that uses the features
[described as "sexy" by the webtorrent team](https://blog.dcpos.ch/how-to-make-your-electron-app-sexy).
*Starting the app without installation*
## Contents
So far the following have been implemented
* `tray.js`: Tray integration
* `progress.js`: Dock badge count and window progress bar
* `notifications.js`: Notifications
* `menu.js`: Custom menu and keyboard shortcuts
* `crash-reporter.js`: Reporting side of the crash reporting
* `drag-drop-main.js`: Handling of drag-and-drop events onto the dock or launcher
* `drag-drop-render.js`: Handling of drag-and-drop events onto the window
## Missing
The following have not yet been implemented in this demo
* One-step build
* Signed installers for all platforms
* Automatic updaters for Mac and Windows
## Running the app without installation
```bash
npm install
npm start
```
*Creating the .deb*
## Creating the .deb
```bash
npm install
npm run build