diff --git a/lib/app/index.js b/lib/app/index.js
index d0b918d..d579681 100644
--- a/lib/app/index.js
+++ b/lib/app/index.js
@@ -71,7 +71,7 @@ class App
})
.option('port', {
alias: 'p',
- describe: 'Port to use',
+ describe: 'Server port',
default: 1571,
type: 'number'
})
@@ -101,7 +101,7 @@ class App
})
.option('initial-send', {
alias: 'i',
- describe: 'Send current file in folder immediately',
+ describe: 'Send files in folder at start',
default: false,
type: 'boolean'
})
diff --git a/readme.md b/readme.md
index a132752..2bd169d 100644
--- a/readme.md
+++ b/readme.md
@@ -2,7 +2,7 @@
An efficient way to share your code while presenting
-### What is keppler
+## What is keppler
Keppler lets you share your code during a presentation.
@@ -12,20 +12,21 @@ Keppler is easy to install and works with NodeJS.
-### Instructions
+## Instructions
+
+#### Requirements
-**Requirements**
* [NodeJS](https://nodejs.org/en/) installed
* Keppler installed globally
* Viewers connected to the same network
-**Install Keppler globally**
+#### Install Keppler globally
```
npm install -g keppler
```
-**Start Keppler inside the project folder**
+#### Start Keppler inside the project folder
```
cd ./my-awesome-project
@@ -34,32 +35,58 @@ keppler "My awesome project"
Share the URL that should appear with the viewers.
-### Current features
+#### config
+
+You can add configuration argument when calling Keppler.
+
+```
+keppler "My project" --debug 0 --port 1234 --exclude "node_modules/**" --open true --test true --initial-send true --max-file-size 99999
+```
+
+or with shortcuts
+
+```
+keppler "My project" -d 0 -p 1234 -e "node_modules/**" -oti -m 99999
+```
+
+Arguments list
+
+|name|shortcut|default value|description|
+|---|---|---|---|
+|`--debug`|`-d`|*(number)*`1`|Debug level (`0`: almost no log, `1`: some logs, `2`: many logs)|
+|`--name`|`-n`|*(string)*`No name`|Project name (you can simply add a string after `keppler` keyword like `keppler "My project"`)|
+|`--port`|`-p`|*(number)*`1571`|Server port|
+|`--exclude`|`-e`|*(string)*`**/.DS_Store,node_modules/**,vendor/**,.git`|Files to exclude|
+|`--open`|`-o`|*(bool)*`true`|Open in default browser|
+|`--test`|`-t`|*(bool)*`false`|Start a test project|
+|`--initial-send`|`-i`|*(bool)*`false`|Send files in folder at start|
+|`--max-file-size`|`-i`|*(number)*`99999`|Maximum file size in octets|
+
+## Features
+
+- Work in any modern browser
- Files tree
- File history/versions
- File versions differences
- Easy copy
- Accessible by anyone on the same network
- App like design
+- Syntax coloring
- Multiple projects in one Keppler instance
-### Futur features
+## Futur features
+- Chat with possibility to associate messages with lines and files
- Log project URL and open in default browser
- Download file button
-- 404
-- Config file
+- Download project button
- Keyboard navigation
- In app notifications
- Browser notifications
- Toggle folder
- Retractable sidebar
- File searching/filtering
-- Project history
- Tooltips
-- Open multiple files
-- Unit testing
- Tablet compatible
-- Angular 2 or React
+- Vue.js
- Font-size control
-- Theme control