Update README.md

Author: Gabriel Chamon Araujo

README.md

@@ -1,11 +1,20 @@
 # sysrsync
 Python module that wraps system calls to rsync
 
+## Requirements
+
+* rsync
+* python 3.6+
+
+**development**:
+
+* pipenv (be sure to have both pipenv and pip upgraded to the latest version)
+
 ## Usage
 
 * Basic file sync
 
-```
+```python
 import sysrsync
 
 sysrsync.run(source='/home/user/foo.txt',
@@ -15,7 +24,7 @@ sysrsync.run(source='/home/user/foo.txt',
 
 * ssh with options
 
-```
+```python
 import sysrsync
 
 sysrsync.run(source='/home/user/files',
@@ -27,7 +36,7 @@ sysrsync.run(source='/home/user/files',
 
 * exclusions
 
-```
+```python
 import sysrsync
 
 sysrsync.run(source='/home/user/files',
@@ -49,11 +58,22 @@ sysrsync.run(source='/home/user/files',
 | verbose | bool | `False` | verbose mode: currently prints rsync command before executing |
 | **kwargs | dict | Not Applicable | arguments that will be forwarded to call to `sysrsync.get_rsync_command` |
 
+**returns**: `subprocess.CompletedProcess`
+
+**raises**: `RsyncError` when `strict = True` and rsync return code is different than 0 ([Success](https://lxadm.com/Rsync_exit_codes#List_of_standard_rsync_exit_codes))
+
 `sysrsync.get_rsync_command`
 
 | argument  | type | default | description |
 | --------- | ---- | ------- | ----------- |
+| source | str | - | Source folder or file |
+| destination | str | - | Destination folder |
+| source_ssh | Optional[str] | None | Remote ssh client where source is located |
+| destination_ssh | Optional[str] | None | Remote ssh client where destination is located |
+| exclusions | Iterable[str] | [] | List of excluded patterns as in rsync's `--exclude` |
+| sync_source_contents | bool | True | Abstracts the elusive trailing slash behaviour that `source` normally has when using rsync directly, i.e. when a trailing slash is present in `source`, the folder's content is synchronized with destination. When no trailing slash is present, the folder itself is synchronized with destination. |
+| options | Iterable[str] | [] | List of options to be used right after rsync call, e.g. `['-a', '-v']` translates to `rsync -a -v` |
 
+**returns**: `List[str]` -> the compiled list of commands to be used directly in `subprocess.run`
 
-
-## 
+**raises**: `RemotesError` when both `source_ssh` and `target_ssh` are set. Normally linux rsync distribution disallows source and destination to be both remotes.