| 1 | <!doctype html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset='utf-8'>
|
| 5 | <title>ipfs-pubsub-room 2.0.0 | Documentation</title>
|
| 6 | <meta name='description' content='IPFS pub-sub room'>
|
| 7 | <meta name='viewport' content='width=device-width,initial-scale=1'>
|
| 8 | <link href='assets/bass.css' rel='stylesheet'>
|
| 9 | <link href='assets/style.css' rel='stylesheet'>
|
| 10 | <link href='assets/github.css' rel='stylesheet'>
|
| 11 | <link href='assets/split.css' rel='stylesheet'>
|
| 12 | </head>
|
| 13 | <body class='documentation m0'>
|
| 14 | <div class='flex'>
|
| 15 | <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
|
| 16 | <div class='py1 px2'>
|
| 17 | <h3 class='mb0 no-anchor'>ipfs-pubsub-room</h3>
|
| 18 | <div class='mb1'><code>2.0.0</code></div>
|
| 19 | <input
|
| 20 | placeholder='Filter'
|
| 21 | id='filter-input'
|
| 22 | class='col12 block input'
|
| 23 | type='text' />
|
| 24 | <div id='toc'>
|
| 25 | <ul class='list-reset h5 py1-ul'>
|
| 26 |
|
| 27 |
|
| 28 | <li><a
|
| 29 | href='#intro'
|
| 30 | class="h5 bold black caps">
|
| 31 | Intro
|
| 32 |
|
| 33 | </a>
|
| 34 |
|
| 35 | </li>
|
| 36 |
|
| 37 | </ul>
|
| 38 | </div>
|
| 39 | <div class='mt1 h6 quiet'>
|
| 40 | <a href='https://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
|
| 41 | </div>
|
| 42 | </div>
|
| 43 | </div>
|
| 44 | <div id='split-right' class='relative overflow-auto height-viewport-100'>
|
| 45 |
|
| 46 |
|
| 47 | <div class='keyline-top-not py2'><section class='py2 clearfix'>
|
| 48 |
|
| 49 | <h2 id='intro' class='mt0'>
|
| 50 | Intro
|
| 51 | </h2>
|
| 52 |
|
| 53 |
|
| 54 | <p>Installable via <code>npm install --save ipfs-pubsub-room</code>, it can also be used directly in the browser.</p>
|
| 55 | <h2>Download</h2>
|
| 56 | <p>The source is available for download from <a href="git+https://github.com/ipfs-shipyard/ipfs-pubsub-room.git">GitHub</a>. Alternatively, you can install using npm:</p>
|
| 57 | <pre class='hljs'>$ npm install --save ipfs-pubsub-room</pre>
|
| 58 | <p>You can then <code>require()</code> ipfs-pubsub-room as normal:</p>
|
| 59 | <pre class='hljs'><span class="hljs-keyword">const</span> ipfsPubsubRoom = <span class="hljs-built_in">require</span>(<span class="hljs-string">'ipfs-pubsub-room'</span>)</pre>
|
| 60 | <h2>In the Browser</h2>
|
| 61 | <p>Ipfs-pubsub-room should work in any ES2015 environment out of the box.</p>
|
| 62 | <p>Usage:</p>
|
| 63 | <pre class='hljs'><span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"text/javascript"</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"index.js"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span></pre>
|
| 64 | <p>The portable versions of ipfs-pubsub-room, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. Ipfs-pubsub-room can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
|
| 65 | <ul>
|
| 66 | <li><a href="https://unpkg.com/ipfs-pubsub-room/dist/index.min.js">https://unpkg.com/ipfs-pubsub-room/dist/index.min.js</a></li>
|
| 67 | <li><a href="https://unpkg.com/ipfs-pubsub-room/dist/index.js">https://unpkg.com/ipfs-pubsub-room/dist/index.js</a></li>
|
| 68 | </ul>
|
| 69 |
|
| 70 |
|
| 71 | </section></div>
|
| 72 |
|
| 73 |
|
| 74 | </div>
|
| 75 | </div>
|
| 76 | <script src='assets/anchor.js'></script>
|
| 77 | <script src='assets/split.js'></script>
|
| 78 | <script src='assets/site.js'></script>
|
| 79 | </body>
|
| 80 | </html>
|