Skip to content
This repository was archived by the owner on Aug 15, 2024. It is now read-only.

Commit 3875fd3

Browse files
committed
better readme
1 parent 5c1097b commit 3875fd3

File tree

1 file changed

+39
-16
lines changed

1 file changed

+39
-16
lines changed

README.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,45 @@
11
# node-libs-browser
22

3-
The node core libs for in browser usage.
3+
The node core libs for in-browser usage.
44

5-
## Module exports
6-
7-
``` javascript
8-
{
9-
assert: "/absolute/path/to/assert",
10-
events: "/absolute/path/to/events",
11-
/* ... */
12-
fs: null // core module without browser replacement
13-
}
14-
```
15-
16-
## Mocks
5+
[![dependencies status](http://david-dm.org/webpack/node-libs-browser.png)](http://david-dm.org/webpack/node-libs-browser)
176

18-
Some modules have mocks in the `mock` directory. This are replacements with minimal functionality.
7+
Exports a hash [object] of absolute paths to each lib, keyed by lib names. Modules without browser replacements are `null`.
198

20-
## dependencies
9+
Some modules have mocks in the `mock` directory. These are replacements with minimal functionality.
2110

22-
[![dependencies status](http://david-dm.org/webpack/node-libs-browser.png)](http://david-dm.org/webpack/node-libs-browser)
11+
| lib name | browser implementation | mock implementation |
12+
|:--------:|:----------------------:|:-------------------:|
13+
| assert | [defunctzombie/commonjs-assert](https://github.com/defunctzombie/commonjs-assert) | --- |
14+
| buffer | [feross/buffer](https://github.com/feross/buffer) | [buffer.js](https://github.com/webpack/node-libs-browser/blob/master/mock/buffer.js) |
15+
| child_process | --- | --- |
16+
| cluster | --- | --- |
17+
| console | [Raynos/console-browserify](https://github.com/Raynos/console-browserify) | [console.js](https://github.com/webpack/node-libs-browser/blob/master/mock/console.js) |
18+
| constants | [juliangruber/constants-browserify](https://github.com/juliangruber/constants-browserify) | --- |
19+
| crypto | [crypto-browserify/crypto-browserify](https://github.com/crypto-browserify/crypto-browserify) | --- |
20+
| dgram | --- | --- |
21+
| dns | --- | [dns.js](https://github.com/webpack/node-libs-browser/blob/master/mock/dns.js) |
22+
| domain | [bevry/domain-browser](https://github.com/bevry/domain-browser) | --- |
23+
| events | [Gozala/events](https://github.com/Gozala/events) | --- |
24+
| fs | --- | --- |
25+
| http | [substack/http-browserify](https://github.com/substack/http-browserify) | --- |
26+
| https | [substack/https-browserify](https://github.com/substack/https-browserify) | --- |
27+
| module | --- | --- |
28+
| net | --- | [net.js](https://github.com/webpack/node-libs-browser/blob/master/mock/net.js) |
29+
| os | [CoderPuppy/os-browserify](https://github.com/CoderPuppy/os-browserify) | --- |
30+
| path | [substack/path-browserify](https://github.com/substack/path-browserify) | --- |
31+
| process | [shtylman/node-process](https://github.com/shtylman/node-process) | [process.js](https://github.com/webpack/node-libs-browser/blob/master/mock/process.js) |
32+
| punycode | [bestiejs/punycode.js](https://github.com/bestiejs/punycode.js) | --- |
33+
| querystring | [mike-spainhower/querystring](https://github.com/mike-spainhower/querystring) | --- |
34+
| readline | --- | --- |
35+
| repl | --- | --- |
36+
| stream | [substack/stream-browserify](https://github.com/substack/stream-browserify) | --- |
37+
| string_decoder | [rvagg/string_decoder](https://github.com/rvagg/string_decoder) | --- |
38+
| sys | [defunctzombie/node-util](https://github.com/defunctzombie/node-util) | --- |
39+
| timers | [jryans/timers-browserify](https://github.com/jryans/timers-browserify) | --- |
40+
| tls | --- | [tls.js](https://github.com/webpack/node-libs-browser/blob/master/mock/tls.js) |
41+
| tty | [substack/tty-browserify](https://github.com/substack/tty-browserify) | [tty.js](https://github.com/webpack/node-libs-browser/blob/master/mock/tty.js) |
42+
| url | [defunctzombie/node-url](https://github.com/defunctzombie/node-url) | --- |
43+
| util | [defunctzombie/node-util](https://github.com/defunctzombie/node-util) | --- |
44+
| vm | [substack/vm-browserify](https://github.com/substack/vm-browserify) | --- |
45+
| zlib | [devongovett/browserify-zlib](https://github.com/devongovett/browserify-zlib) | --- |

0 commit comments

Comments
 (0)