fluencelabs/js-libp2p-websockets
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-websockets synced 2025-04-25 08:22:24 +00:00
Code Issues Projects Releases Wiki Activity

chore: update documentation

Browse Source
This commit is contained in:
Jacob Heun 2020-08-11 16:18:49 +02:00
parent 089e58f88b
commit 8c87e59caf
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F
3 changed files with 32 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
index.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset='utf-8'>
<title>libp2p-websockets 0.13.6 | Documentation</title>
<title>libp2p-websockets 0.14.0 | Documentation</title>
<meta name='description' content='JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec'>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' rel='stylesheet'>
@ -15,26 +15,19 @@
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>libp2p-websockets</h3>
<div class='mb1'><code>0.13.6</code></div>
<div class='mb1'><code>0.14.0</code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block input'
spellcheck='false'
autocapitalize='off'
autocorrect='off'
type='text' />
<div id='toc'>
<ul class='list-reset h5 py1-ul'>
<li><a
href='#intro'
class="h5 bold black caps">
Intro
</a>
</li>
<li><a
href='#websockets'
class=" toggle-sibling">
@ -84,34 +77,6 @@
<div id='split-right' class='relative overflow-auto height-viewport-100'>
<div class='keyline-top-not py2'><section class='py2 clearfix'>
<h2 id='intro' class='mt0'>
Intro
</h2>
<p>Installable via <code>npm install --save libp2p-websockets</code>, it can also be used directly in the browser.</p>
<h2>Download</h2>
<p>The source is available for download from <a href="git+https://github.com/libp2p/js-libp2p-websockets.git">GitHub</a>. Alternatively, you can install using npm:</p>
<pre class='hljs'>$ npm install --save libp2p-websockets</pre>
<p>You can then <code>require()</code> libp2p-websockets as normal:</p>
<pre class='hljs'><span class="hljs-keyword">const</span> libp2PWebsockets = <span class="hljs-built_in">require</span>(<span class="hljs-string">'libp2p-websockets'</span>)</pre>
<h2>In the Browser</h2>
<p><code>libp2p-websockets</code> should work in any ECMAScript 2018 environment out of the box.</p>
<p>Usage:</p>
<pre class='hljs'><span class="hljs-tag">&lt;<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>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></pre>
<p>The portable versions of <code>libp2p-websockets</code>, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. <code>libp2p-websockets</code> can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
<ul>
<li><a href="https://unpkg.com/libp2p-websockets/dist/index.min.js">https://unpkg.com/libp2p-websockets/dist/index.min.js</a></li>
<li><a href="https://unpkg.com/libp2p-websockets/dist/index.js">https://unpkg.com/libp2p-websockets/dist/index.js</a></li>
</ul>
</section></div>
<section class='p2 mb2 clearfix bg-white minishadow'>
@ -122,7 +87,7 @@
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-websockets/blob/a37c2bd7f78b4ff671e20f7af5db4a494cb995f6/src/index.js#L18-L131'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-websockets/blob/662d04128cedcadad63a937a9d20dc14ca5c6713/src/index.js#L18-L131'>
<span>src/index.js</span>
</a>
@ -151,6 +116,8 @@
@ -171,7 +138,7 @@
<div class='clearfix'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-websockets/blob/a37c2bd7f78b4ff671e20f7af5db4a494cb995f6/src/index.js#L38-L48'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-websockets/blob/662d04128cedcadad63a937a9d20dc14ca5c6713/src/index.js#L38-L48'>
<span>src/index.js</span>
</a>
@ -262,6 +229,8 @@
</section>
</div>
@ -281,7 +250,7 @@
<div class='clearfix'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-websockets/blob/a37c2bd7f78b4ff671e20f7af5db4a494cb995f6/src/index.js#L105-L112'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-websockets/blob/662d04128cedcadad63a937a9d20dc14ca5c6713/src/index.js#L105-L112'>
<span>src/index.js</span>
</a>
@ -375,6 +344,8 @@ anytime a new incoming Connection has been successfully upgraded via
</section>
</div>
@ -394,7 +365,7 @@ anytime a new incoming Connection has been successfully upgraded via
<div class='clearfix'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-websockets/blob/a37c2bd7f78b4ff671e20f7af5db4a494cb995f6/src/index.js#L119-L130'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-websockets/blob/662d04128cedcadad63a937a9d20dc14ca5c6713/src/index.js#L119-L130'>
<span>src/index.js</span>
</a>
@ -452,6 +423,8 @@ anytime a new incoming Connection has been successfully upgraded via
</section>
</div>