Skip to content

Commit 3c56320

Browse files
Add readme
1 parent 3e31203 commit 3c56320

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# browserify-data
2+
3+
Dataify your [browserify](https://github.com/substack/node-browserify) bundles.
4+
5+
## Data me up
6+
7+
Want to package up some data, manifest, or config files in your browserify bundle? Then you've come to the right place.
8+
9+
## What can I use
10+
11+
Right now, browserify-data will recognize and bundle JSON, CSON, and YAML files.
12+
13+
## How to install
14+
15+
```bash
16+
npm install browserify-data
17+
```
18+
19+
## How to use
20+
21+
Require it:
22+
23+
```js
24+
var data = require('./data.json|cson|yaml');
25+
```
26+
27+
browserify it with the JavaScript API:
28+
29+
```js
30+
var bd = require('browserify-data');
31+
32+
var b = browserify();
33+
b.transform(bd);
34+
b.add('main.js');
35+
b.bundle(...);
36+
```
37+
38+
...or the CLI:
39+
40+
```bash
41+
browserify -t browserify-cson main.js > bundle.js
42+
```
43+
44+
## Contribute
45+
46+
1. Fork
47+
2. Create
48+
3. Code
49+
4. Push
50+
5. Submit
51+
6. Yay!
52+
53+
## License
54+
55+
(The MIT License)
56+
57+
Copyright (c) 2013 Ian Lollar
58+
59+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
60+
61+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
62+
63+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)