diff options
| author | Arnold Schrijver <aschrijver@users.noreply.github.com> | 2017-07-28 23:54:24 +0200 |
|---|---|---|
| committer | Joe Hand <joe@joeahand.com> | 2017-07-28 14:54:24 -0700 |
| commit | 5a05041340b814508015fb46979cdb57fad10d44 (patch) | |
| tree | bf279bdeb377d2e34e94930c2d4b6297c4431225 /docs | |
| parent | 45f82beb025200b3c2a703a7b967d5eeb2247cf8 (diff) | |
| download | dat-docs-5a05041340b814508015fb46979cdb57fad10d44.tar.gz dat-docs-5a05041340b814508015fb46979cdb57fad10d44.zip | |
Update browser.md add compatibility warning (#73) (#76)
* Update browser.md add compatibility warning (#73)
Hi @joehand,
I've added the PR on the dat-js compatibility warning (https://github.com/datproject/docs/issues/73#issuecomment-318415769)
* Add a few details & clarify options to connect to other clients.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cookbook/browser.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/cookbook/browser.md b/docs/cookbook/browser.md index 0a7d0bd..42c043b 100644 --- a/docs/cookbook/browser.md +++ b/docs/cookbook/browser.md @@ -4,7 +4,11 @@ Dat is written in JavaScript, so naturally, it can work entirely in the browser! This approach is similar to that used in Feross' [Web Torrent](http://webtorrent.io). The difference is that Dat links can be rendered live and read dynamically, whereas BitTorrent links are static. The original owner can update the files in the directory and all peers will receive the updates automatically. -Because dat-js uses webrtc, it can only connect to other browser clients. It is not possible for the dat-js library to connect to the UTP and UDP clients used in the Node.js versions. +## WebRTC Usage Notes + +**Important**: dat-js uses WebRTC, so it can only connect to other WebRTC clients. It is not possible for the dat-js library to connect directly clients using other protocols. All other Dat applications use non-WebRTC protocols ([see this FAQ for more info](https://docs.datproject.org/faq#does-dat-use-webrtc)). Non-browser clients can connect dats peer-to-peer via webrtc modules, such as [electron-webrtc](https://github.com/mappum/electron-webrtc), or use proxies via websockets, http, or other client-server protocols. + +Due to WebRTC's less than stellar performance - Dat has focused on creating solid networking using other protocols. We may integrate WebRTC if performance improves and it becomes easier to run in non-browser interfaces (though we'd prefer using [more performant options](https://github.com/noffle/web-udp) in the browser, if they develop). OK, now for the goods. |