[update] Readme

This commit is contained in:
Bruno Simon
2016-11-03 15:00:27 +01:00
committed by GitHub
parent 9a07218880
commit 2491a46e98
+14 -6
View File
@@ -6,7 +6,7 @@ An efficient way to share your code while presenting
Keppler lets you share your code during a presentation. Keppler lets you share your code during a presentation.
Start keppler inside your project folder, share the URL with the viewers and start coding. When you save or change any files, viewers receive them, can browse through the files tree and discover changes you've made. Start keppler inside your project folder, share the URL with the viewers and start coding. When you save or change any file, viewers receive them, can browse through the files tree and discover changes you've made.
Keppler is easy to install and works with NodeJS. Keppler is easy to install and works with NodeJS.
@@ -17,7 +17,7 @@ Keppler is easy to install and works with NodeJS.
**Requirements** **Requirements**
* [NodeJS](https://nodejs.org/en/) installed * [NodeJS](https://nodejs.org/en/) installed
* Keppler installed globally * Keppler installed globally
* Viewer connected to the same network * Viewers connected to the same network
**Install Keppler globally** **Install Keppler globally**
@@ -29,21 +29,29 @@ npm install -g keppler
``` ```
cd ./my-awesome-project cd ./my-awesome-project
keppler "My project" keppler "My awesome project"
``` ```
Share the URL that should appear with the viewers. Share the URL that should appear with the viewers.
### Current features
- Files tree
- File history/versions
- File versions differences
- Easy copy
- Accessible by anyone on the same network
- App like design
- Multiple projects in one Keppler instance
### Futur features ### Futur features
- Log project URL and open in default browser - Log project URL and open in default browser
- Font size buttons
- Download file button - Download file button
- 404 - 404
- Config file - Config file
- Keyboard navigation - Keyboard navigation
- In app notifications - In app notifications
- Navigator notifications - Browser notifications
- Toggle folder - Toggle folder
- Retractable sidebar - Retractable sidebar
- File searching/filtering - File searching/filtering
@@ -52,6 +60,6 @@ Share the URL that should appear with the viewers.
- Open multiple files - Open multiple files
- Unit testing - Unit testing
- Tablet compatible - Tablet compatible
- Angular 2 - Angular 2 or React
- Font-size control - Font-size control
- Theme control - Theme control