diff --git a/readme.md b/readme.md index 7165d6e..a132752 100644 --- a/readme.md +++ b/readme.md @@ -6,7 +6,7 @@ An efficient way to share your code while presenting 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. @@ -17,7 +17,7 @@ Keppler is easy to install and works with NodeJS. **Requirements** * [NodeJS](https://nodejs.org/en/) installed * Keppler installed globally -* Viewer connected to the same network +* Viewers connected to the same network **Install Keppler globally** @@ -29,21 +29,29 @@ npm install -g keppler ``` cd ./my-awesome-project -keppler "My project" +keppler "My awesome project" ``` 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 - Log project URL and open in default browser -- Font size buttons - Download file button - 404 - Config file - Keyboard navigation - In app notifications -- Navigator notifications +- Browser notifications - Toggle folder - Retractable sidebar - File searching/filtering @@ -52,6 +60,6 @@ Share the URL that should appear with the viewers. - Open multiple files - Unit testing - Tablet compatible -- Angular 2 +- Angular 2 or React - Font-size control - Theme control