[update] Wording

This commit is contained in:
brunosimon
2016-09-17 23:46:53 +02:00
parent ae800cc01f
commit c537e69c2e
3 changed files with 20 additions and 20 deletions
+1 -1
View File
@@ -13,7 +13,7 @@
"type": "git", "type": "git",
"url": "https://github.com/brunosimon/keppler" "url": "https://github.com/brunosimon/keppler"
}, },
"author": "Bruno Simon", "author": "Bruno Simon <contact@bruno-simon.com> (http://bruno-simon.ninja)",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/brunosimon/keppler/issues" "url": "https://github.com/brunosimon/keppler/issues"
+10 -14
View File
@@ -10,7 +10,7 @@ Start keppler inside your project folder, share the URL with the viewers and sta
Keppler is easy to install and works with NodeJS. Keppler is easy to install and works with NodeJS.
![Project screen](resources/screenshots/screen-project-1.png) ![Project screen](https://github.com/brunosimon/keppler/raw/master/resources/screenshots/screen-project-1.png)
### Instructions ### Instructions
@@ -32,27 +32,23 @@ cd ./my-awesome-project
keppler "My project" keppler "My project"
``` ```
The project URL appears. Share it with the viewers on the same wifi. Share the URL that should appear with the viewers.
### Todo
- [ ] NPM package
### Futur features ### Futur features
- Log project URL and open in default browser - Log project URL and open in default browser
- 404 - 404
- Retractable sidebar - Config file
- Open multiple files - Copy file to clipboard
- Download file
- Keyboard navigation - Keyboard navigation
- In app notifications - In app notifications
- Navigator notifications - Navigator notifications
- Config file - Toggle folder
- Retractable sidebar
- File searching/filtering
- Tooltips
- Open multiple files
- Unit testing - Unit testing
- Tablet compatible - Tablet compatible
- File searching/filtering
- Toggle folder
- Tooltips
- Copy file to clipboard
- Download file
- Angular 2 - Angular 2
+9 -5
View File
@@ -59,7 +59,7 @@ section.text
| What is keppler | What is keppler
.description .description
p p
| Keppler lets you share your code simply during a presentation. | Keppler lets you share your code during a presentation.
br br
| 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 files, viewers receive them, can browse through the files tree and discover changes you've made.
p p
@@ -73,17 +73,21 @@ section.text
| Requirements: | Requirements:
ul ul
li li
| - NodeJS installed | -
a(href='https://nodejs.org/en/',target="_blank")="NodeJS"
| installed
li li
| - Spectators connected to the same wifi | - Keppler installed globally
li
| - Viewer connected to the same wifi
p p
| Install Keppler globally | Install Keppler globally:
pre pre
code code
span.line.opacity-20 span.line.opacity-20
| npm install -g keppler | npm install -g keppler
p p
| Go to the project folder and start Keppler | Start Keppler inside the project folder:
pre pre
code code
span.line.opacity-20 span.line.opacity-20