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

chore: update documentation

Browse Source
This commit is contained in:
Vasco Santos 2020-07-15 12:29:32 +02:00
parent 6cad2632dc
commit bde733800a
3 changed files with 20 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
index.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset='utf-8'> <meta charset='utf-8'>
<title>libp2p-utils 0.1.2 | Documentation</title> <title>libp2p-utils 0.1.3 | Documentation</title>
<meta name='description' content='Package to aggregate shared logic and dependencies for the libp2p ecosystem'> <meta name='description' content='Package to aggregate shared logic and dependencies for the libp2p ecosystem'>
<meta name='viewport' content='width=device-width,initial-scale=1'> <meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' rel='stylesheet'> <link href='assets/bass.css' rel='stylesheet'>
@ -15,25 +15,18 @@
<div id='split-left' class='overflow-auto fs0 height-viewport-100'> <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'> <div class='py1 px2'>
<h3 class='mb0 no-anchor'>libp2p-utils</h3> <h3 class='mb0 no-anchor'>libp2p-utils</h3>
<div class='mb1'><code>0.1.2</code></div> <div class='mb1'><code>0.1.3</code></div>
<input <input
placeholder='Filter' placeholder='Filter'
id='filter-input' id='filter-input'
class='col12 block input' class='col12 block input'
spellcheck='false'
autocapitalize='off'
autocorrect='off'
type='text' /> type='text' />
<div id='toc'> <div id='toc'>
<ul class='list-reset h5 py1-ul'> <ul class='list-reset h5 py1-ul'>
<li><a
href='#intro'
class="h5 bold black caps">
Intro
</a>
</li>
</ul> </ul>
</div> </div>
<div class='mt1 h6 quiet'> <div class='mt1 h6 quiet'>
@ -43,34 +36,6 @@
</div> </div>
<div id='split-right' class='relative overflow-auto height-viewport-100'> <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-utils</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-utils.git">GitHub</a>. Alternatively, you can install using npm:</p>
<pre class='hljs'>$ npm install --save libp2p-utils</pre>
<p>You can then <code>require()</code> libp2p-utils as normal:</p>
<pre class='hljs'><span class="hljs-keyword">const</span> libp2PUtils = <span class="hljs-built_in">require</span>(<span class="hljs-string">'libp2p-utils'</span>)</pre>
<h2>In the Browser</h2>
<p>Libp2p-utils should work in any ES2015 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 libp2p-utils, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. Libp2p-utils can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
<ul>
<li><a href="https://unpkg.com/libp2p-utils/dist/index.min.js">https://unpkg.com/libp2p-utils/dist/index.min.js</a></li>
<li><a href="https://unpkg.com/libp2p-utils/dist/index.js">https://unpkg.com/libp2p-utils/dist/index.js</a></li>
</ul>
</section></div>
</div> </div>
</div> </div>
<script src='assets/anchor.js'></script> <script src='assets/anchor.js'></script>