diff --git a/README.md b/README.md index 1213c28..c2c62c1 100644 --- a/README.md +++ b/README.md @@ -71,36 +71,12 @@ See the [Node.js Request README][req] for several more examples. Request intends ## Browserify -Browser Request is a [browserify][browserify]-enabled package. +To build Browser Request, run: -First, add `browser-request` to your Node project + npm run build - $ npm install browser-request +a `dist` directory will be created with `request.js` and `request.min.js`. -Next, make a module that uses the package. - -```javascript -// example.js - Example front-end (client-side) code using browser-request via browserify -// -var request = require('browser-request') -request('/', function(er, res) { - if(!er) - return console.log('browser-request got your root path:\n' + res.body) - - console.log('There was an error, but at least browser-request loaded and ran!') - throw er -}) -``` - -To build this for the browser, run it through browserify. - - $ browserify --entry example.js --outfile example-built.js - -Deploy `example-built.js` to your web site and use it from your page. - -```html - -``` ## License Browser Request is licensed under the Apache 2.0 license. diff --git a/package.json b/package.json index 1c356d8..f3c8785 100644 --- a/package.json +++ b/package.json @@ -18,12 +18,15 @@ "url": "git://github.com/iriscouch/browser-request" }, "scripts": { - "test": "beefy test.js" + "test": "beefy test.js", + "build": "mkdir -p dist && browserify index.js -o dist/request.js -s request && cd dist && uglifyjs request.js -o request.min.js", + "clean": "rm -rf dist" }, "devDependencies": { "tape": "~1.0.4", "beefy": "~0.4.0", - "browserify": "~2.25.0" + "browserify": "~2.25.0", + "uglify-js": "~2.4.24" }, "engines": [ "node"