Merge pull request #33 from zenflow/develop

better readme

Author: sokra

README.md

@@ -1,22 +1,45 @@
 # node-libs-browser
 
-The node core libs for in browser usage.
+The node core libs for in-browser usage.
 
-## Module exports
-
-``` javascript
-{
-	assert: "/absolute/path/to/assert",
-	events: "/absolute/path/to/events",
-	/* ... */
-	fs: null // core module without browser replacement
-}
-```
-
-## Mocks
+[![dependencies status](http://david-dm.org/webpack/node-libs-browser.png)](http://david-dm.org/webpack/node-libs-browser)
 
-Some modules have mocks in the `mock` directory. This are replacements with minimal functionality.
+Exports a hash [object] of absolute paths to each lib, keyed by lib names. Modules without browser replacements are `null`.
 
-## dependencies
+Some modules have mocks in the `mock` directory. These are replacements with minimal functionality.
 
-[![dependencies status](http://david-dm.org/webpack/node-libs-browser.png)](http://david-dm.org/webpack/node-libs-browser)
+| lib name | browser implementation | mock implementation |
+|:--------:|:----------------------:|:-------------------:|
+| assert | [defunctzombie/commonjs-assert](https://github.com/defunctzombie/commonjs-assert) | --- |
+| buffer | [feross/buffer](https://github.com/feross/buffer) | [buffer.js](https://github.com/webpack/node-libs-browser/blob/master/mock/buffer.js) |
+| child_process | --- | --- |
+| cluster | --- | --- |
+| console | [Raynos/console-browserify](https://github.com/Raynos/console-browserify) | [console.js](https://github.com/webpack/node-libs-browser/blob/master/mock/console.js) |
+| constants | [juliangruber/constants-browserify](https://github.com/juliangruber/constants-browserify) | --- |
+| crypto | [crypto-browserify/crypto-browserify](https://github.com/crypto-browserify/crypto-browserify) | --- |
+| dgram | --- | --- |
+| dns | --- | [dns.js](https://github.com/webpack/node-libs-browser/blob/master/mock/dns.js) |
+| domain | [bevry/domain-browser](https://github.com/bevry/domain-browser) | --- |
+| events | [Gozala/events](https://github.com/Gozala/events) | --- |
+| fs | --- | --- |
+| http | [substack/http-browserify](https://github.com/substack/http-browserify) | --- |
+| https | [substack/https-browserify](https://github.com/substack/https-browserify) | --- |
+| module | --- | --- |
+| net | --- | [net.js](https://github.com/webpack/node-libs-browser/blob/master/mock/net.js) |
+| os | [CoderPuppy/os-browserify](https://github.com/CoderPuppy/os-browserify) | --- |
+| path | [substack/path-browserify](https://github.com/substack/path-browserify) | --- |
+| process | [shtylman/node-process](https://github.com/shtylman/node-process) | [process.js](https://github.com/webpack/node-libs-browser/blob/master/mock/process.js) |
+| punycode | [bestiejs/punycode.js](https://github.com/bestiejs/punycode.js) | --- |
+| querystring | [mike-spainhower/querystring](https://github.com/mike-spainhower/querystring) | --- |
+| readline | --- | --- |
+| repl | --- | --- |
+| stream | [substack/stream-browserify](https://github.com/substack/stream-browserify) | --- |
+| string_decoder | [rvagg/string_decoder](https://github.com/rvagg/string_decoder) | --- |
+| sys | [defunctzombie/node-util](https://github.com/defunctzombie/node-util) | --- |
+| timers | [jryans/timers-browserify](https://github.com/jryans/timers-browserify) | --- | 
+| tls | --- | [tls.js](https://github.com/webpack/node-libs-browser/blob/master/mock/tls.js) |
+| tty | [substack/tty-browserify](https://github.com/substack/tty-browserify) | [tty.js](https://github.com/webpack/node-libs-browser/blob/master/mock/tty.js) |
+| url | [defunctzombie/node-url](https://github.com/defunctzombie/node-url) | --- |
+| util | [defunctzombie/node-util](https://github.com/defunctzombie/node-util) | --- |
+| vm | [substack/vm-browserify](https://github.com/substack/vm-browserify) | --- |
+| zlib | [devongovett/browserify-zlib](https://github.com/devongovett/browserify-zlib) | --- |