chore: update documentation

This commit is contained in:
Jacob Heun 2020-02-17 16:21:37 -05:00
parent 6408f581ca
commit 30c9d3d6b8
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F

View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset='utf-8'>
<title>libp2p-interfaces 0.2.5 | Documentation</title>
<title>libp2p-interfaces 0.2.6 | Documentation</title>
<meta name='description' content='Interfaces for JS Libp2p'>
<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-interfaces</h3>
<div class='mb1'><code>0.2.5</code></div>
<div class='mb1'><code>0.2.6</code></div>
<input
placeholder='Filter'
id='filter-input'
@ -58,10 +58,10 @@
<p>You can then <code>require()</code> libp2p-interfaces as normal:</p>
<pre class='hljs'><span class="hljs-keyword">const</span> libp2PInterfaces = <span class="hljs-built_in">require</span>(<span class="hljs-string">'libp2p-interfaces'</span>)</pre>
<h2>In the Browser</h2>
<p>Libp2p-interfaces should work in any ES2015 environment out of the box.</p>
<p><code>libp2p-interfaces</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 libp2p-interfaces, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. Libp2p-interfaces can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
<p>The portable versions of <code>libp2p-interfaces</code>, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. <code>libp2p-interfaces</code> can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
<ul>
<li><a href="https://unpkg.com/libp2p-interfaces/dist/index.min.js">https://unpkg.com/libp2p-interfaces/dist/index.min.js</a></li>
<li><a href="https://unpkg.com/libp2p-interfaces/dist/index.js">https://unpkg.com/libp2p-interfaces/dist/index.js</a></li>