commit of version 0.1.0

Author: loye

.gitignore

@@ -1,25 +1,3 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# Deployed apps should consider commenting this line out:
-# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
 node_modules
+#WebStorm project files
+.idea/

.npmignore

@@ -0,0 +1,3 @@
+.gitignore
+#WebStorm project files
+.idea/

README.md

@@ -1,4 +1,41 @@
-proxy.stream
+proxy-stream
 ============
 
 It's a nodejs proxy, implemented steam interface, supports socks4, socks4a, socks5 and http.
+
+## How to use
+
+Use `new Proxy({ type: 'direct' })` to create a proxy stream.
+
+###Example 1: direct access
+
+It start an proxy on port 2000;
+
+```js
+var net = require('net');
+var Proxy = require('proxy.stream').Proxy;
+net.createServer(function (s) {
+  var proxy = new Proxy(); //it's equal to new Proxy({ type: 'direct' })
+  s.pipe(proxy).pipe(s);
+}).listen(2000, function () {
+  console.log('http/socks4/socks5 proxy listening on port 2000');
+});
+```
+
+###Example 2: access throw another proxy
+
+It turns the socks5 proxy [localhost:2000] to another proxy supports http/socks4/socks5!
+
+```js
+var net = require('net');
+var Proxy = require('proxy.stream').Proxy;
+net.createServer(function (s) {
+  s.pipe(new Proxy({ type: 'socks5', host: 'localhost', port: 2000 })).pipe(s);
+}).listen(8080, function () {
+  console.log('http/socks4/socks5 proxy listening on port 8080');
+});
+```
+
+###More
+
+This is a stream, it can be used simply in multiple scenarios.

example.js

@@ -0,0 +1,22 @@
+// Author       : Lijian Qiu
+// Email        : loye.qiu@gmail.com
+// Description  : examples of creating proxy server
+
+var net = require('net');
+
+var Proxy = require('./').Proxy;
+
+//Example 1: direct access
+net.createServer(function (s) {
+  var proxy = new Proxy(); //it's equal to new Proxy({ type: 'direct' })
+  s.pipe(proxy).pipe(s);
+}).listen(2000, function () {
+  console.log('http/socks4/socks5 proxy listening on port 2000');
+});
+
+//Example 2: access throw another proxy
+net.createServer(function (s) {
+  s.pipe(new Proxy({ type: 'socks5', host: 'localhost', port: 2000 })).pipe(s);
+}).listen(8080, function () {
+  console.log('http/socks4/socks5 proxy listening on port 8080');
+});

index.js

@@ -0,0 +1,7 @@
+// Author       : Lijian Qiu
+// Email        : loye.qiu@gmail.com
+// Description  :
+
+
+//exports
+exports.Proxy = require('./lib/proxy').Proxy;