Skip to content

Commit

Permalink
[update] Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
sergsadovyi committed Jan 23, 2017
1 parent d0eef7f commit 29b666e
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,42 @@ Directory Synchronizer
Console tool to synchronize files in two directories.

### Usage
Install
#### Install

git clone https://github.com/HopeUA/dir-sync.git dir-sync
cd dir-sync
composer install --optimize-autoloader

Configure
... in development
#### Configure
Write your configuration to __app/config/parameters.yml__

Run tests
app.name: app

app.master.storage: local
app.master.path: /master
app.master.filters:
path:
pattern: '~[a-z]\.mp4~'
excludeEpisodes:
path: '/path/to/file.json'

app.slave.storage: local
app.slave.path: /slave
app.slave.path_tpl: /__program__/__uid__
app.slave.filters: null

app.logger: file
file.log.path: %kernel.logs_dir%/sync.log

#### Run tests

bin/phpunit -c app/
composer test

#### Schedule
Add new cronjob to run synchronization periodically

php app/console sync:run
php bin/console sync:run

Logs are stored in *app/logs/sync.log*
#### Monitor
Default logs location – *var/logs/sync.log*

0 comments on commit 29b666e

Please sign in to comment.