README.md in motion_vj-0.1.0 vs README.md in motion_vj-0.2.0
- old
+ new
@@ -6,14 +6,43 @@
Install the gem and make the executable available:
$ gem install motion_vj
+## Configuration
+
+The configuration file should look like this:
+
+```yaml
+# config.yml
+
+# To obtain the app key and secret, go to https://www.dropbox.com/developers/apps/create
+db_app_key: <App key from Dropbox>
+db_app_secret: <App secret from Dropbox>
+# The token can be generated using `--get-token`. Please see the Usage section of the README.
+db_app_token: <App token from Dropbox>
+# The Dropbox directory where the files will be uploaded.
+db_videos_dir: /
+
+# The motion CLI name.
+motion_cmd: motion
+# Path to the PID file that will be created when running.
+pid_file: /var/run/motion/motion.pid
+# Directory where motion save the videos.
+videos_dir: /var/run/motion/videos
+# Extension of the videos that should be uploaded.
+videos_extension: avi
+```
+
+You must provide it using the `--config-file` option as pointed by the [Usage](#usage) section.
+
## Usage
-Once installed, a Dropbox token is needed to start. Run `motionvj --get-token` and follow the instructions.
+So that `motionvj` can access a Dropbox account, a Dropbox token needs to be created. This will be a one time action, and it can be acomplished running `motionvj --get-token --config-file config.yml`, where `config.yml` is the file detailed by the [Configuration](#configuration) section of this README. Once the token is created, it should be added to the same configuration file.
-For more details, run `motionvj --help`:
+To start uploading new videos, just run `motionvj --config-file config.yml`. This should upload new videos that end with the extension indicated by the configuration file. After a file is uploaded to Dropbox, it is then deleted from the local filesystem.
+
+For more options, run `motionvj --help`:
```
Usage: motionvj [options]
Required:
-c, --config-file [CONFIG_FILE] Path to the configuration file