[update] Readme

2016-09-16 18:19:54 +02:00
parent 80580433ac
commit b7264eaaf5
3 changed files with 62 additions and 3 deletions
@@ -0,0 +1,60 @@
+# Keppler
+
+An efficient way to share your code while presenting
+
+### What is keppler
+
+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.
+
+Keppler is easy to install and works with NodeJS.
+
+![Project screen](resources/screenshots/screen-project-1.png)
+
+### Instructions
+
+**Requirements**
+* [NodeJS](https://nodejs.org/en/) installed
+* Keppler installed globally
+* Viewer connected to the same wifi
+
+**Install Keppler globally**
+
+```
+npm install -g keppler
+```
+
+**Start Keppler inside the project folder**
+
+```
+cd ./my-awesome-project
+keppler "My project"
+```
+
+The project URL appears. Share it with the viewers on the same wifi.
+
+### Todo
+
+- [ ] Prevent new version if no change
+- [ ] Ignore too big files
+- [ ] Ignore non txt files
+- [ ] NPM package
+
+### Futur features
+
+- 404
+- Retractable sidebar
+- Open multiple files
+- Keyboard navigation
+- In app notifications
+- Navigator notifications
+- Config file
+- Unit testing
+- Tablet compatible
+- File searching/filtering
+- Toggle folder
+- Tooltips
+- Copy file to clipboard
+- Download file
+- Angular 2