Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add to README.md switch between request and browser-request #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,30 @@ 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
<script src="example-built.js"></script> <!-- Runs the request, outputs the result to the console -->
```

## Switch between request and browser-request when browserify

In order to switch between regular `request` and `browser-request` when browserify, add the following to the `package.json`


```json
"browser": {
"request": "browser-request"
}
```

Now you can just call `request` and browserify will know what to do.

```javascript
var request = require('request')
```

## License

Browser Request is licensed under the Apache 2.0 license.
Expand Down