fluencelabs/js-libp2p-crypto
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-crypto synced 2025-04-25 02:02:31 +00:00
Code Issues Projects Releases Wiki Activity

chore: update documentation

Browse Source
This commit is contained in:
Jacob Heun 2020-02-26 17:21:52 +01:00
parent 4d91e9e054
commit 127e418e1e
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
index.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset='utf-8'>
<title>libp2p-crypto 0.17.2 | Documentation</title>
<title>libp2p-crypto 0.17.3 | Documentation</title>
<meta name='description' content='Crypto primitives for 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-crypto</h3>
<div class='mb1'><code>0.17.2</code></div>
<div class='mb1'><code>0.17.3</code></div>
<input
placeholder='Filter'
id='filter-input'
@ -108,10 +108,10 @@
<p>You can then <code>require()</code> libp2p-crypto as normal:</p>
<pre class='hljs'><span class="hljs-keyword">const</span> libp2PCrypto = <span class="hljs-built_in">require</span>(<span class="hljs-string">'libp2p-crypto'</span>)</pre>
<h2>In the Browser</h2>
<p>Libp2p-crypto should work in any ES2015 environment out of the box.</p>
<p><code>libp2p-crypto</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-crypto, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. Libp2p-crypto can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
<p>The portable versions of <code>libp2p-crypto</code>, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. <code>libp2p-crypto</code> can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
<ul>
<li><a href="https://unpkg.com/libp2p-crypto/dist/index.min.js">https://unpkg.com/libp2p-crypto/dist/index.min.js</a></li>
<li><a href="https://unpkg.com/libp2p-crypto/dist/index.js">https://unpkg.com/libp2p-crypto/dist/index.js</a></li>
@ -132,7 +132,7 @@
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/ad4bf3b35779cb22e5df1b11a0504fb8a885a072/src/keys/rsa-class.js#L103-L106'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/d3601fa936a6f5adf17d737378bf043ff97ce0cd/src/keys/rsa-class.js#L103-L106'>
<span>src/keys/rsa-class.js</span>
</a>
@ -195,7 +195,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/ad4bf3b35779cb22e5df1b11a0504fb8a885a072/src/keys/rsa-class.js#L114-L134'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/d3601fa936a6f5adf17d737378bf043ff97ce0cd/src/keys/rsa-class.js#L114-L134'>
<span>src/keys/rsa-class.js</span>
</a>
@ -271,7 +271,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/ad4bf3b35779cb22e5df1b11a0504fb8a885a072/src/keys/rsa.js#L10-L10'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/d3601fa936a6f5adf17d737378bf043ff97ce0cd/src/keys/rsa.js#L10-L10'>
<span>src/keys/rsa.js</span>
</a>
@ -327,7 +327,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/ad4bf3b35779cb22e5df1b11a0504fb8a885a072/src/keys/ed25519-class.js#L84-L87'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/d3601fa936a6f5adf17d737378bf043ff97ce0cd/src/keys/ed25519-class.js#L84-L87'>
<span>src/keys/ed25519-class.js</span>
</a>
@ -390,7 +390,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/ad4bf3b35779cb22e5df1b11a0504fb8a885a072/src/pbkdf2.js#L14-L18'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/d3601fa936a6f5adf17d737378bf043ff97ce0cd/src/pbkdf2.js#L14-L18'>
<span>src/pbkdf2.js</span>
</a>