Skip to content

Commit

Permalink
fix readme references to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Langer committed Dec 14, 2017
1 parent 7138a97 commit 1bba4b1
Show file tree
Hide file tree
Showing 10 changed files with 646 additions and 15 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![dependencies](https://img.shields.io/david/screeny05/corrode.svg?style=flat-square)](https://david-dm.org/screeny05/corrode)
[![coverage](https://img.shields.io/coveralls/screeny05/corrode.svg?style=flat-square)](https://coveralls.io/github/screeny05/corrode)
[![build status](https://img.shields.io/travis/screeny05/corrode.svg?style=flat-square)](https://travis-ci.org/screeny05/corrode)
[![docs](https://doc.esdoc.org/github.com/screeny05/corrode/badge.svg)](https://doc.esdoc.org/github.com/screeny05/corrode/)
[![docs](https://corrode.scn.cx/badge.svg)](https://corrode.scn.cx/)

Corrode is a batteries-included library for reading binary data. It helps you converting that blob-mess into useable data.

Expand Down Expand Up @@ -84,9 +84,9 @@ If you'd like to include your own examples, just open a PR. I'm more than happy


## Documentation & API Reference
* [Corrode Overview](https://doc.esdoc.org/github.com/screeny05/corrode/manual/overview.html)
* [API Reference](https://doc.esdoc.org/github.com/screeny05/corrode/identifiers.html)
* [Getting Started](https://doc.esdoc.org/github.com/screeny05/corrode/manual/tutorial.html)
* [Corrode Overview](https://corrode.scn.cx/manual/overview.html)
* [API Reference](https://corrode.scn.cx/identifiers.html)
* [Getting Started](https://corrode.scn.cx/manual/getting-started.html)


## Why use corrode over dissolve
Expand Down
8 changes: 4 additions & 4 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ <h2 id="--p-"><p></p></h2><p><a href="./LICENSE"><img src="https://img.shields.i
<a href="https://david-dm.org/screeny05/corrode"><img src="https://img.shields.io/david/screeny05/corrode.svg?style=flat-square" alt="dependencies"></a>
<a href="https://coveralls.io/github/screeny05/corrode"><img src="https://img.shields.io/coveralls/screeny05/corrode.svg?style=flat-square" alt="coverage"></a>
<a href="https://travis-ci.org/screeny05/corrode"><img src="https://img.shields.io/travis/screeny05/corrode.svg?style=flat-square" alt="build status"></a>
<a href="https://doc.esdoc.org/github.com/screeny05/corrode/"><img src="https://doc.esdoc.org/github.com/screeny05/corrode/badge.svg" alt="docs"></a></p>
<a href="https://corrode.scn.cx/"><img src="https://corrode.scn.cx/badge.svg" alt="docs"></a></p>
<p>Corrode is a batteries-included library for reading binary data. It helps you converting that blob-mess into useable data.</p>
<p>Use it to parse <em>that one</em> obscure binary-file with the help of JavaScript.</p>
<h4 id="install">Install</h4><pre><code><code class="source-code prettyprint">$ npm install --save corrode</code>
Expand Down Expand Up @@ -105,9 +105,9 @@ <h2 id="examples">Examples</h2><p>All examples can be found in the examples/-fol
</ul>
<p>If you&apos;d like to include your own examples, just open a PR. I&apos;m more than happy to not have to think about existing complex structured binary data to parse myself.</p>
<h2 id="documentation--amp--api-reference">Documentation &amp; API Reference</h2><ul>
<li><a href="https://doc.esdoc.org/github.com/screeny05/corrode/manual/overview.html">Corrode Overview</a></li>
<li><a href="https://doc.esdoc.org/github.com/screeny05/corrode/identifiers.html">API Reference</a></li>
<li><a href="https://doc.esdoc.org/github.com/screeny05/corrode/manual/tutorial.html">Getting Started</a></li>
<li><a href="https://corrode.scn.cx/manual/overview.html">Corrode Overview</a></li>
<li><a href="https://corrode.scn.cx/identifiers.html">API Reference</a></li>
<li><a href="https://corrode.scn.cx/manual/getting-started.html">Getting Started</a></li>
</ul>
<h2 id="why-use-corrode-over-dissolve">Why use corrode over dissolve</h2><p>It solves most of the major shortcomings dissolve has:</p>
<ul>
Expand Down
12 changes: 10 additions & 2 deletions docs/index.json
View file

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions docs/manual/CHANGELOG.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,27 @@
<div data-ice="manual">
<ul class="manual-toc">

<li data-ice="manualNav" class="indent-h1" data-link="manual/getting-started.html"><a href="manual/getting-started.html" data-ice="link">Getting started</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#introduction" data-ice="link">Introduction</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#data-structure" data-ice="link">Data Structure</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#how-we--39-ll-do-this" data-ice="link">How we&apos;ll do this</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#let--39-s-get-started" data-ice="link">Let&apos;s get started</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-header-parser" data-ice="link">The header parser</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-index-parser" data-ice="link">The index parser</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-index-entry-parser" data-ice="link">The index entry parser</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-index-parser-itself" data-ice="link">The index parser itself</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-data-parser" data-ice="link">The data parser</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-data-entry-parser" data-ice="link">The data-entry parser</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-data-parser-itself" data-ice="link">The data parser itself</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/getting-started.html"><a href="manual/getting-started.html#wiring-everything-together" data-ice="link">Wiring everything together</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#parsing-a-file" data-ice="link">Parsing a file</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#escaping-callback-hell" data-ice="link">Escaping callback-hell</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#further-reading" data-ice="link">Further reading</a></li>
</ul>
</div>
<div data-ice="manual">
<ul class="manual-toc">

<li data-ice="manualNav" class="indent-h1" data-link="manual/configuration.html"><a href="manual/configuration.html" data-ice="link">Configuration</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/configuration.html"><a href="manual/configuration.html#-code-endianness--code-" data-ice="link">endianness</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/configuration.html"><a href="manual/configuration.html#-code-loopidentifier--code-" data-ice="link">loopIdentifier</a></li>
Expand Down
21 changes: 21 additions & 0 deletions docs/manual/configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,27 @@
<div data-ice="manual">
<ul class="manual-toc">

<li data-ice="manualNav" class="indent-h1" data-link="manual/getting-started.html"><a href="manual/getting-started.html" data-ice="link">Getting started</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#introduction" data-ice="link">Introduction</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#data-structure" data-ice="link">Data Structure</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#how-we--39-ll-do-this" data-ice="link">How we&apos;ll do this</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#let--39-s-get-started" data-ice="link">Let&apos;s get started</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-header-parser" data-ice="link">The header parser</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-index-parser" data-ice="link">The index parser</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-index-entry-parser" data-ice="link">The index entry parser</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-index-parser-itself" data-ice="link">The index parser itself</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-data-parser" data-ice="link">The data parser</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-data-entry-parser" data-ice="link">The data-entry parser</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/getting-started.html"><a href="manual/getting-started.html#the-data-parser-itself" data-ice="link">The data parser itself</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/getting-started.html"><a href="manual/getting-started.html#wiring-everything-together" data-ice="link">Wiring everything together</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#parsing-a-file" data-ice="link">Parsing a file</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#escaping-callback-hell" data-ice="link">Escaping callback-hell</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/getting-started.html"><a href="manual/getting-started.html#further-reading" data-ice="link">Further reading</a></li>
</ul>
</div>
<div data-ice="manual">
<ul class="manual-toc">

<li data-ice="manualNav" class="indent-h1" data-link="manual/configuration.html"><a href="manual/configuration.html" data-ice="link">Configuration</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/configuration.html"><a href="manual/configuration.html#-code-endianness--code-" data-ice="link">endianness</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/configuration.html"><a href="manual/configuration.html#-code-loopidentifier--code-" data-ice="link">loopIdentifier</a></li>
Expand Down
Loading

0 comments on commit 1bba4b1

Please sign in to comment.