README.md in rdiff-simple-0.0.9 vs README.md in rdiff-simple-0.1.0
- old
+ new
@@ -14,14 +14,36 @@
## Installation
$ gem install rdiff-simple
+## Quick Start
+
+In your file:
+
+```ruby
+ require 'rdiff_simple'
+
+ backup = RdiffSimple::RdiffBackup.new
+ backup.execute('/source', '/destination', :print_statistics, exclude: '/source/private')
+```
+
## Usage
-$ rdiff-simple
+Arguments Order is:
+- `source`
+- `destination`
+- `flag options like --exclude-other-filesystems`
+- `hash arguments like --exclude /usr/bin`
+
+All multi-word symbols should be converted to underscores: `--exclude-other-filesystems` becomes `:exclude_other_filesystems`.
+
+The `execute` method will return the exit code from rdiff-backup. In order to get the output from rdiff-backup pass in a [`Logger`][logger] to [`RdiffBackup.new`][new].
+
## License
Released under the MIT License. See the [LICENSE][] file for further details.
[license]: LICENSE.txt
+[logger]: http://www.ruby-doc.org/stdlib-2.0.0/libdoc/logger/rdoc/Logger.html
+[new]: http://rubydoc.info/github/ketiko/rdiff-simple/master/RdiffSimple/RdiffBackup#initialize-instance_method