From 8198db872efd9c541376a10d76f37f3e660ab5b8 Mon Sep 17 00:00:00 2001 From: tigerbot Date: Fri, 21 Apr 2017 17:26:10 -0600 Subject: [PATCH] added specifics about contents to the readme --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6151392..01cce4c 100644 --- a/README.md +++ b/README.md @@ -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