diff --git a/readme.md b/readme.md index b3a7007..29de4a9 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ # msynk - rsync helper that supports encryption and presets -## DESCRIPTION +## Description **msynk** uses *rsync* to synchronise files or directories locally or between devices. In general, you should always add a trailing '/' to directories. @@ -29,7 +29,7 @@ To sync the directories "/home/user/foo" "/home/user/bar" and the file "/home/us ``` You can then run this with: `msynk -c my_backup`, or if you only want to sync the "foo" directory and ".txt" files: `msynk -c my_backup foo .txt` -## OPTIONS +## Options - `-h, --help` Show a list of arguments. - `--settings` Show the current settings. - `-c, --config config-name` Retrieve settings from config file ~/.config/msynk/*config-name*