Skip to content

Commit

Permalink
add readme + package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
citronneur committed Jul 1, 2015
1 parent 6613ec0 commit 35c21bc
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,28 @@ node-rdp
========

Remote Desktop Protocol for Node.js

node-rdp is a pure implementation of the Microsoft RDP (Remote Desktop Protocol) protocol (client and server side). node-rdp support only SSL security layer.

## Simple RDP Client

To create a simple rdp client :

```javascript
var rdp = require('rdp');

rdp.createClient({
domain : 'my_domain',
userName : 'my_username',
password : 'my_password',
enablePerf : true,
autoLogin : true,
screen : { width : 800, height : 600 }
}).on('connect', function () {
}).on('bitmap', function(bitmap) {
}).on('close', function() {
}).on('error', function(err) {
}).connect(infos.ip, infos.port);
```

Most of bitmap are encoded with RLE (Run Length Encoding) algorithm. It's not the purpose of node-rdp to embed decompression algorithm. See mstsc.js to see a pure javascript implementation (for browser).
23 changes: 23 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "node-rdp",
"version": "0.1.0",
"engines":
[
"node = 0.10.x"
],

"description": "Remote Desktop Protocol in Node.js",
"license": "GPL",
"repository":
{
"type": "git",
"url": "https://github.com/citronneur/node-rdp"
},

"main": "server.js",
"dependencies":
{
"starttls": "lastest",
"bignum": "lastest"
}
}

0 comments on commit 35c21bc

Please sign in to comment.