Browse Source

docs...

master
jojapoppa 1 year ago
parent
commit
4214cea149
3 changed files with 22 additions and 25 deletions
  1. +5
    -5
      docs/classes/base58.html
  2. +12
    -15
      docs/index.html
  3. +5
    -5
      docs/modules.html

+ 5
- 5
docs/classes/base58.html View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Base58 | @turtlecoin/base58</title>
<meta name="description" content="Documentation for @turtlecoin/base58">
<title>Base58 | fedoragold-base58</title>
<meta name="description" content="Documentation for fedoragold-base58">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@turtlecoin/base58</a>
<a href="../index.html" class="title">fedoragold-base58</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@turtlecoin/base58</a>
<a href="../modules.html">fedoragold-base58</a>
</li>
<li>
<a href="base58.html">Base58</a>
@@ -229,4 +229,4 @@
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
</html>

+ 12
- 15
docs/index.html View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>@turtlecoin/base58</title>
<meta name="description" content="Documentation for @turtlecoin/base58">
<title>fedoragold-base58</title>
<meta name="description" content="Documentation for fedoragold-base58">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">@turtlecoin/base58</a>
<a href="index.html" class="title">fedoragold-base58</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -48,7 +48,7 @@
</div>
<div class="tsd-page-title">
<div class="container">
<h1>@turtlecoin/base58</h1>
<h1>fedoragold-base58</h1>
</div>
</div>
</header>
@@ -57,24 +57,21 @@
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<p><img src="https://user-images.githubusercontent.com/34389545/35821974-62e0e25c-0a70-11e8-87dd-2cfffeb6ed47.png" alt="image"></p>
<a href="#turtlecoin-base58-helper" id="turtlecoin-base58-helper" style="color: inherit; text-decoration: none;">
<h1>TurtleCoin Base58 Helper</h1>
<a href="#fedoragold-base58-helper" id="fedoragold-base58-helper" style="color: inherit; text-decoration: none;">
<h1>Fedoragold Base58 Helper</h1>
</a>
<p><img src="https://img.shields.io/badge/node-%3E%3D12-blue.svg" alt="Prerequisite"> <a href="https://github.com/TurtleCoin/node-turtlecoin-base58#readme"><img src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" alt="Documentation"></a> <a href="https://github.com/TurtleCoin/node-turtlecoin-base58/graphs/commit-activity"><img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" alt="Maintenance"></a> <a href="https://github.com/TurtleCoin/node-turtlecoin-base58/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-GPL--3.0-yellow.svg" alt="License: GPL-3.0"></a> <a href="https://twitter.com/_TurtleCoin"><img src="https://img.shields.io/twitter/follow/_TurtleCoin.svg?style=social" alt="Twitter: TurtlePay"></a></p>
<p><a href="https://npmjs.com/package/@turtlecoin/base58"><img src="https://nodeico.herokuapp.com/@turtlecoin/base58.svg" alt="NPM"></a></p>
<p>This package contains the code paths necessary to encode and/or decode hexadecimal strings to Base58 encoding and back again.</p>
<p><img src="https://img.shields.io/badge/node-%3E%3D12-blue.svg" alt="Prerequisite"> <a href="https://www.fedoragold.com"><img src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" alt="Documentation"></a> <a href="https://git.fedoragold.com/jojapoppa/fedoragold-base58.git/graphs/commit-activity"><img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" alt="Maintenance"></a> <a href="https://git.fedoragold.com/jojapoppa/fedoragold-base58.git"><img src="https://img.shields.io/badge/License-GPL--3.0-yellow.svg" alt="License: GPL-3.0"></a></p>
<p>This package contains the code paths necessary to encode and/or decode hexadecimal strings to Base58 encoding and back again. Adapted for use by Fedoragold from the Turtlecoin project.</p>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h2>Installation</h2>
</a>
<pre><code class="language-bash"><span style="color: #000000">npm install @turtlecoin/base58</span>
</code></pre>
<a href="#initialization" id="initialization" style="color: inherit; text-decoration: none;">
<h2>Initialization</h2>
</a>
<a href="#typescript" id="typescript" style="color: inherit; text-decoration: none;">
<h3>TypeScript</h3>
</a>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Base58</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@turtlecoin/base58&#039;</span>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Base58</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;fedoragold-base58&#039;</span>

<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">rawAddress</span><span style="color: #000000"> = </span><span style="color: #001080">Base58</span><span style="color: #000000">.</span><span style="color: #795E26">decode</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;TRTLv3JRA772aBveLkCjG5jDvoUdKwa8YDsgLxCczL1oPei42XAMLE5QLRHM2c8oo5WbwLiB5ky7mDP7WGB53Jnp2ygHEomu3qa&#039;</span><span style="color: #000000">)</span>

@@ -83,7 +80,7 @@
<a href="#javascript" id="javascript" style="color: inherit; text-decoration: none;">
<h3>JavaScript</h3>
</a>
<pre><code class="language-javascript"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">Base58</span><span style="color: #000000"> = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;@turtlecoin/base58&#039;</span><span style="color: #000000">).</span><span style="color: #001080">Base58</span>
<pre><code class="language-javascript"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">Base58</span><span style="color: #000000"> = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;fedoragold-base58&#039;</span><span style="color: #000000">).</span><span style="color: #001080">Base58</span>

<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">rawAddress</span><span style="color: #000000"> = </span><span style="color: #001080">Base58</span><span style="color: #000000">.</span><span style="color: #795E26">decode</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;TRTLv3JRA772aBveLkCjG5jDvoUdKwa8YDsgLxCczL1oPei42XAMLE5QLRHM2c8oo5WbwLiB5ky7mDP7WGB53Jnp2ygHEomu3qa&#039;</span><span style="color: #000000">)</span>

@@ -92,7 +89,7 @@
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h3>Documentation</h3>
</a>
<p>You can find the full documentation for this library <a href="https://base58.turtlecoin.dev">here</a></p>
<p>You can find the full documentation for this library <a href="https://www.fedoragold.com">here</a></p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -132,4 +129,4 @@
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>
</html>

+ 5
- 5
docs/modules.html View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>@turtlecoin/base58</title>
<meta name="description" content="Documentation for @turtlecoin/base58">
<title>fedoragold-base58</title>
<meta name="description" content="Documentation for fedoragold-base58">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">@turtlecoin/base58</a>
<a href="index.html" class="title">fedoragold-base58</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -48,7 +48,7 @@
</div>
<div class="tsd-page-title">
<div class="container">
<h1>@turtlecoin/base58</h1>
<h1>fedoragold-base58</h1>
</div>
</div>
</header>
@@ -106,4 +106,4 @@
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>
</html>

Loading…
Cancel
Save