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 Chrome App build #1697

Open
wants to merge 3 commits into
base: master
from
Open
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

readme: add Chrome App usage instructions

  • Loading branch information
feross committed Aug 9, 2019
commit 3f4119377147c568aeadf73f602fa832ee2d46f3
@@ -175,8 +175,8 @@ you use [node](http://nodejs.org/)-style require() to organize your browser code

##### Webpack

WebTorrent also works with [webpack](http://webpack.github.io/), a module bundler similar
to browserify. However, webpack requires the following extra configuration:
WebTorrent also works with [webpack](https://webpack.js.org/), another module
bundler. However, webpack requires the following extra configuration:

```js
{
@@ -187,22 +187,8 @@ to browserify. However, webpack requires the following extra configuration:
}
```

If you are on webpack 1.x, you will also need to add the `json-loader`:
```js
{
module: {
loaders: [
// make sure to install the 'json-loader' package: npm install json-loader
{
test: /\.json$/,
loader: 'json'
}
]
}
}
```

Otherwise you could also directly use the pre-built version via `require('webtorrent/webtorrent.min')`.
Or, you can just use the pre-built version via
`require('webtorrent/webtorrent.min.js')` and skip the webpack configuration.

##### Script tag

@@ -221,6 +207,18 @@ MaxCDN) for easy inclusion on your site:
<script src="https://cdn.jsdelivr.net/npm/webtorrent@latest/webtorrent.min.js"></script>
```

##### Chrome App

If you want to use WebTorrent in a
[Chrome App](https://developer.chrome.com/apps/about_apps), you can include the
following script:

```html
<script src="webtorrent.chromeapp.js"></script>
```

Be sure to enable the `chrome.sockets.udp` and `chrome.sockets.tcp` permissions!

#### In Node.js

WebTorrent also works in node.js, using the *same npm package!* It's mad science!
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.