fluencelabs/js-libp2p-tcp
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-tcp synced 2025-04-25 12:52:32 +00:00
Code Issues Projects Releases Wiki Activity

chore: update documentation

Browse Source
This commit is contained in:
Jacob Heun 2020-07-17 12:37:27 +02:00
parent cdc08ebcea
commit 2e3ce73816
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F
3 changed files with 21 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
index.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset='utf-8'>
<title>libp2p-tcp 0.14.5 | Documentation</title>
<title>libp2p-tcp 0.14.6 | Documentation</title>
<meta name='description' content='Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces'>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' rel='stylesheet'>
@ -15,7 +15,7 @@
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>libp2p-tcp</h3>
<div class='mb1'><code>0.14.5</code></div>
<div class='mb1'><code>0.14.6</code></div>
<input
placeholder='Filter'
id='filter-input'
@ -28,16 +28,6 @@
<ul class='list-reset h5 py1-ul'>
<li><a
href='#intro'
class="h5 bold black caps">
Intro
</a>
</li>
<li><a
href='#tcp'
class=" toggle-sibling">
@ -87,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-tcp</code>, it can also be used directly in the browser.</p>
<h2>Download</h2>
<p>The source is available for download from <a href="https://github.com/libp2p/js-libp2p-tcp.git">GitHub</a>. Alternatively, you can install using npm:</p>
<pre class='hljs'>$ npm install --save libp2p-tcp</pre>
<p>You can then <code>require()</code> libp2p-tcp as normal:</p>
<pre class='hljs'><span class="hljs-keyword">const</span> libp2PTcp = <span class="hljs-built_in">require</span>(<span class="hljs-string">'libp2p-tcp'</span>)</pre>
<h2>In the Browser</h2>
<p><code>libp2p-tcp</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-tcp</code>, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. <code>libp2p-tcp</code> can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
<ul>
<li><a href="https://unpkg.com/libp2p-tcp/dist/index.min.js">https://unpkg.com/libp2p-tcp/dist/index.min.js</a></li>
<li><a href="https://unpkg.com/libp2p-tcp/dist/index.js">https://unpkg.com/libp2p-tcp/dist/index.js</a></li>
</ul>
</section></div>
<section class='p2 mb2 clearfix bg-white minishadow'>
@ -125,7 +87,7 @@
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/562b3adf1f8bccb1328f220bb62cc53ae1d6e10e/src/index.js#L17-L139'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/82b99076d054a0849d82de3ea3c5ae0f7b79892f/src/index.js#L17-L139'>
<span>src/index.js</span>
</a>
@ -176,7 +138,7 @@
<div class='clearfix'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/562b3adf1f8bccb1328f220bb62cc53ae1d6e10e/src/index.js#L37-L45'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/82b99076d054a0849d82de3ea3c5ae0f7b79892f/src/index.js#L37-L45'>
<span>src/index.js</span>
</a>
@ -287,7 +249,7 @@
<div class='clearfix'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/562b3adf1f8bccb1328f220bb62cc53ae1d6e10e/src/index.js#L114-L121'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/82b99076d054a0849d82de3ea3c5ae0f7b79892f/src/index.js#L114-L121'>
<span>src/index.js</span>
</a>
@ -376,7 +338,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-tcp/blob/562b3adf1f8bccb1328f220bb62cc53ae1d6e10e/src/index.js#L128-L138'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/82b99076d054a0849d82de3ea3c5ae0f7b79892f/src/index.js#L128-L138'>
<span>src/index.js</span>
</a>