README.md in bdsync-2.1.1 vs README.md in bdsync-2.1.2

- old
+ new

@@ -18,10 +18,26 @@ $ gem install bdsync ## Usage -TODO: Write usage instructions here +bdsync_sftp: Bidirectional synchronization from and to a sftp server directory: + +```bash +bdsync_sftp --site ftp.example.com --user root --local_root_path /tmp/local_test --remote_root_path /tmp/remote_test +# OR +bdsync_sftp -s ftp.example.com -u root -l /tmp/local_test -r /tmp/remote_test +``` + +You can use [`direct_ssh`](https://rubygems.org/gems/direct_ssh/) to setup ssh authorization if necessary. + +bdsync_lfs: Bidirectional synchronization from and to a local file directory: + +```bash +bdsync_lfs --local_root_path /tmp/local_test --remote_root_path /tmp/remote_test +# OR +bdsync_lfs -l /tmp/local_test -r /tmp/remote_test +``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.