Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
citronneur committed Jul 2, 2015
1 parent 68994ad commit 420fb36
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,17 @@ var client = rdp.createClient({
}).connect('XXX.XXX.XXX.XXX', 3389);
```

Name | type | Description
-----|------|------------
domain|string|Microsoft domain
userName|string|Username
password|string|password
enablePerf|boolean|Active some performance features (disable wallpaper)
autoLogin|boolean|start session if login informations are good
decompress|boolean|use RLE algorrithm for decompress bitmap
screen|object|{width : integer, height : integer} screen size
Client parameters

* domain {string} Microsoft domain
* userName {string} Username
* password {string} password
* enablePerf {boolean} Active some performance features (disable wallpaper)
* autoLogin {boolean} start session if login informations are good
* decompress {boolean} use RLE algorrithm for decompress bitmap
* screen {object} screen size
** width {integer} width of screen
** height {integer} height of screen

Use decompress parameter may decrease performance.

Expand Down

0 comments on commit 420fb36

Please sign in to comment.