fluencelabs/js-peer-id
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-peer-id synced 2025-06-28 14:01:54 +00:00
Code Issues Projects Releases Wiki Activity

chore: update documentation

Browse Source
This commit is contained in:
Vasco Santos
2020-03-18 17:38:53 +01:00
parent f503c3ac47
commit 1397f54709
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
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>peer-id 0.13.9 | Documentation</title> <title>peer-id 0.13.10 | Documentation</title>
<meta name='description' content='IPFS Peer Id implementation in Node.js'> <meta name='description' content='IPFS Peer Id implementation in Node.js'>
<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,7 +15,7 @@
<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'>peer-id</h3> <h3 class='mb0 no-anchor'>peer-id</h3>
<div class='mb1'><code>0.13.9</code></div> <div class='mb1'><code>0.13.10</code></div>
<input <input
placeholder='Filter' placeholder='Filter'
id='filter-input' id='filter-input'
@ -78,10 +78,10 @@
<p>You can then <code>require()</code> peer-id as normal:</p> <p>You can then <code>require()</code> peer-id as normal:</p>
<pre class='hljs'><span class="hljs-keyword">const</span> peerId = <span class="hljs-built_in">require</span>(<span class="hljs-string">'peer-id'</span>)</pre> <pre class='hljs'><span class="hljs-keyword">const</span> peerId = <span class="hljs-built_in">require</span>(<span class="hljs-string">'peer-id'</span>)</pre>
<h2>In the Browser</h2> <h2>In the Browser</h2>
<p>Peer-id should work in any ES2015 environment out of the box.</p> <p><code>peer-id</code> should work in any ECMAScript 2018 environment out of the box.</p>
<p>Usage:</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> <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 peer-id, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. Peer-id can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p> <p>The portable versions of <code>peer-id</code>, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. <code>peer-id</code> can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
<ul> <ul>
<li><a href="https://unpkg.com/peer-id/dist/index.min.js">https://unpkg.com/peer-id/dist/index.min.js</a></li> <li><a href="https://unpkg.com/peer-id/dist/index.min.js">https://unpkg.com/peer-id/dist/index.min.js</a></li>
<li><a href="https://unpkg.com/peer-id/dist/index.js">https://unpkg.com/peer-id/dist/index.js</a></li> <li><a href="https://unpkg.com/peer-id/dist/index.js">https://unpkg.com/peer-id/dist/index.js</a></li>
@ -102,7 +102,7 @@
</h3> </h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/1d86506c6404ff25eddc1719f6f535404cfee96b/src/index.js#L147-L155'> <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/efc96106a4ba308d759b7f8a6880c6eccc107f36/src/index.js#L148-L156'>
<span>src/index.js</span> <span>src/index.js</span>
</a> </a>
@ -175,7 +175,7 @@
</h3> </h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/1d86506c6404ff25eddc1719f6f535404cfee96b/src/index.js#L163-L165'> <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/efc96106a4ba308d759b7f8a6880c6eccc107f36/src/index.js#L164-L166'>
<span>src/index.js</span> <span>src/index.js</span>
</a> </a>