From e7ccaa0c743537d74fc4091f4a4b496bcc67aa9b Mon Sep 17 00:00:00 2001 From: Chris Chua Date: Sun, 17 Oct 2010 19:49:32 +0800 Subject: Some documentation. --- README | 7 ------- README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 7 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 14d4134..0000000 --- a/README +++ /dev/null @@ -1,7 +0,0 @@ -Node-mjpeg-proxy - -This is a simple implementation of a mjpeg proxy written with node.js. - -Please note more is to come, I'm still changing my head from SVN to GIT sorry for the delay - --Phil Rene diff --git a/README.md b/README.md new file mode 100644 index 0000000..14e1366 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +node-mjpeg-proxy +================ + +This is a simple implementation of a MJPEG proxy written with node.js. + +## Documentation + +### Example Usage + + var mpjegproxy = require("./lib/node-mjpeg-proxy"); + mpjegproxy.createProxy("http://192.1.2.3:8080/videofeed"); + +Here, it will create a proxy to the source video feed (http://192.1.2.3:8080/videofeed) with the default options (below). You can now access the feed at http://localhost:5080/ . + +### Proxy + + Proxy.createProxy(sourceURL, [options]); + +Returns: a `Proxy` instance. + +Arguments: + +- *sourceURL* + The source URL of the video feed to be proxied. + +Options: + +- *port* + The destination port. Defaults to `5080`. + +## TODO + +- Add a resource URL so that it can serve on certain resource URLs rather than require its onw http.Server instance. + +## Credits + +- Phil Rene ([philrene](http://github.com/philrene)) -- cgit v1.2.1