Browse Source

docs

master
jojapoppa 8 months ago
parent
commit
2d8a42ff77
6 changed files with 38 additions and 38 deletions
  1. +6
    -5
      README.md
  2. +5
    -5
      docs/classes/reader.html
  3. +5
    -5
      docs/classes/varint.html
  4. +5
    -5
      docs/classes/writer.html
  5. +12
    -13
      docs/index.html
  6. +5
    -5
      docs/modules.html

+ 6
- 5
README.md View File

@@ -2,26 +2,27 @@

# FedoraGold Bytestream Helper

![Prerequisite](https://img.shields.io/badge/node-%3E%3D12-blue.svg) [![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/TurtleCoin/node-bytestream-helper#readme) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/TurtleCoin/node-bytestream-helper/graphs/commit-activity) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/TurtleCoin/node-bytestream-helper/blob/master/LICENSE)
![Prerequisite](https://img.shields.io/badge/node-%3E%3D12-blue.svg) [![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://www.fedoragold.com) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://git.fedoragold.com/jojapoppa/fedoragold-bytestream.git/graphs/commit-activity) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://git.fedoragold.com/jojapoppa/fedoragold-bytestream.git)

This package contains the code paths necessary to assist with encoding and decoding bytestreams (blobs).

It was designed and written primarily for working with FedoraGold bytestreams.
This coded was adapted from the Turtlecoin project for use in Fedoragold (FED).
It was designed and written primarily for working with Turtlecoin & FedoraGold bytestreams.

### TypeScript

```typescript
import { Reader, Writer } from '@turtlecoin/bytestream'
import { Reader, Writer } from 'fedoragold-bytestream'
```

### JavaScript

```javascript
const BytestreamHelper = require('@turtlecoin/bytestream')
const BytestreamHelper = require('fedoragold-bytestream')
const Reader = BytestreamHelper.Reader
const Writer = BytestreamHelper.Writer
```

### Documentation

You can find the full documentation for this library [here](https://bytestream.turtlecoin.dev)
You can find the full documentation for this library [here](https://www.fedoragold.com)

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

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Reader | @turtlecoin/bytestream</title>
<meta name="description" content="Documentation for @turtlecoin/bytestream">
<title>Reader | fedoragold-bytestream</title>
<meta name="description" content="Documentation for fedoragold-bytestream">
<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/bytestream</a>
<a href="../index.html" class="title">fedoragold-bytestream</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/bytestream</a>
<a href="../modules.html">fedoragold-bytestream</a>
</li>
<li>
<a href="reader.html">Reader</a>
@@ -1025,4 +1025,4 @@
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
</html>

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

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Varint | @turtlecoin/bytestream</title>
<meta name="description" content="Documentation for @turtlecoin/bytestream">
<title>Varint | fedoragold-bytestream</title>
<meta name="description" content="Documentation for fedoragold-bytestream">
<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/bytestream</a>
<a href="../index.html" class="title">fedoragold-bytestream</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/bytestream</a>
<a href="../modules.html">fedoragold-bytestream</a>
</li>
<li>
<a href="varint.html">Varint</a>
@@ -239,4 +239,4 @@
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
</html>

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

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Writer | @turtlecoin/bytestream</title>
<meta name="description" content="Documentation for @turtlecoin/bytestream">
<title>Writer | fedoragold-bytestream</title>
<meta name="description" content="Documentation for fedoragold-bytestream">
<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/bytestream</a>
<a href="../index.html" class="title">fedoragold-bytestream</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/bytestream</a>
<a href="../modules.html">fedoragold-bytestream</a>
</li>
<li>
<a href="writer.html">Writer</a>
@@ -909,4 +909,4 @@
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
</html>

+ 12
- 13
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/bytestream</title>
<meta name="description" content="Documentation for @turtlecoin/bytestream">
<title>fedoragold-bytestream</title>
<meta name="description" content="Documentation for fedoragold-bytestream">
<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/bytestream</a>
<a href="index.html" class="title">fedoragold-bytestream</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/bytestream</h1>
<h1>fedoragold-bytestream</h1>
</div>
</div>
</header>
@@ -57,13 +57,12 @@
<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-bytestream-helper" id="turtlecoin-bytestream-helper" style="color: inherit; text-decoration: none;">
<h1>TurtleCoin Bytestream Helper</h1>
<a href="fedoragold-bytestream-helper" id="fedoragold-bytestream-helper" style="color: inherit; text-decoration: none;">
<h1>Fedoragold Bytestream 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-bytestream-helper#readme"><img src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" alt="Documentation"></a> <a href="https://github.com/TurtleCoin/node-bytestream-helper/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-bytestream-helper/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></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/bytestream"><img src="https://nodeico.herokuapp.com/@turtlecoin/bytestream.svg" alt="NPM"></a></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-bytestream.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-bytestream.git"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a></p>
<p>This package contains the code paths necessary to assist with encoding and decoding bytestreams (blobs).</p>
<p>It was designed and written primarily for working with TurtleCoin bytestreams.</p>
<p>It was designed and written primarily for working with TurtleCoin and Fedoragold bytestreams.</p Adapted for use by Fedoragold (FED) from the Turtlecoin project.>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h2>Installation</h2>
</a>
@@ -75,19 +74,19 @@
<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">Reader</span><span style="color: #000000">, </span><span style="color: #001080">Writer</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@turtlecoin/bytestream&#039;</span>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Reader</span><span style="color: #000000">, </span><span style="color: #001080">Writer</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;fedoragold-bytestream&#039;</span>
</code></pre>
<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">BytestreamHelper</span><span style="color: #000000"> = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;@turtlecoin/bytestream&#039;</span><span style="color: #000000">)</span>
<pre><code class="language-javascript"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">BytestreamHelper</span><span style="color: #000000"> = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;fedoragold-bytestream&#039;</span><span style="color: #000000">)</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">Reader</span><span style="color: #000000"> = </span><span style="color: #001080">BytestreamHelper</span><span style="color: #000000">.</span><span style="color: #001080">Reader</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">Writer</span><span style="color: #000000"> = </span><span style="color: #001080">BytestreamHelper</span><span style="color: #000000">.</span><span style="color: #001080">Writer</span>
</code></pre>
<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://bytestream.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">
@@ -137,4 +136,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/bytestream</title>
<meta name="description" content="Documentation for @turtlecoin/bytestream">
<title>fedoragold-bytestream</title>
<meta name="description" content="Documentation for fedoragold-bytestream">
<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/bytestream</a>
<a href="index.html" class="title">fedoragold-bytestream</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/bytestream</h1>
<h1>fedoragold-bytestream</h1>
</div>
</div>
</header>
@@ -118,4 +118,4 @@
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>
</html>

Loading…
Cancel
Save