diff --git a/package.json b/package.json index 06be127..594b3db 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ "type": "git", "url": "https://github.com/brunosimon/keppler" }, - "author": "Bruno Simon", + "author": "Bruno Simon (http://bruno-simon.ninja)", "license": "MIT", "bugs": { "url": "https://github.com/brunosimon/keppler/issues" diff --git a/readme.md b/readme.md index aff8789..8b81b10 100644 --- a/readme.md +++ b/readme.md @@ -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. -![Project screen](resources/screenshots/screen-project-1.png) +![Project screen](https://github.com/brunosimon/keppler/raw/master/resources/screenshots/screen-project-1.png) ### Instructions @@ -32,27 +32,23 @@ cd ./my-awesome-project keppler "My project" ``` -The project URL appears. Share it with the viewers on the same wifi. - -### Todo - -- [ ] NPM package +Share the URL that should appear with the viewers. ### Futur features - Log project URL and open in default browser - 404 -- Retractable sidebar -- Open multiple files +- Config file +- Copy file to clipboard +- Download file - Keyboard navigation - In app notifications - Navigator notifications -- Config file +- Toggle folder +- Retractable sidebar +- File searching/filtering +- Tooltips +- Open multiple files - Unit testing - Tablet compatible -- File searching/filtering -- Toggle folder -- Tooltips -- Copy file to clipboard -- Download file - Angular 2 diff --git a/site/views/pages/index/projects.pug b/site/views/pages/index/projects.pug index 998a15b..5ee3b05 100644 --- a/site/views/pages/index/projects.pug +++ b/site/views/pages/index/projects.pug @@ -59,7 +59,7 @@ section.text | What is keppler .description p - | Keppler lets you share your code simply during a presentation. + | Keppler lets you share your code during a presentation. 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. p @@ -73,17 +73,21 @@ section.text | Requirements: ul li - | - NodeJS installed + | - + a(href='https://nodejs.org/en/',target="_blank")="NodeJS" + | installed li - | - Spectators connected to the same wifi + | - Keppler installed globally + li + | - Viewer connected to the same wifi p - | Install Keppler globally + | Install Keppler globally: pre code span.line.opacity-20 | npm install -g keppler p - | Go to the project folder and start Keppler + | Start Keppler inside the project folder: pre code span.line.opacity-20