Skip to content

Commit

Permalink
regen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@JustinBeaudry
JustinBeaudry committed Jul 29, 2018
1 parent e5606d4 commit 305cd02
Show file tree
Hide file tree
Showing 12 changed files with 13 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/Collection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1844,7 +1844,7 @@ <h5>Example</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/Collection.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ <h1 class="page-title">Collection.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enum.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ <h5>Example</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enum.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h1 class="page-title">Enum.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/MissingIndexError_MissingIndexError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ <h5>Parameters:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/Model.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1018,7 +1018,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/Model.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ <h1 class="page-title">Model.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/Serializable.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/Serializable.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h1 class="page-title">Serializable.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/UnsupportedError_UnsupportedError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ <h5>Parameters:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/errors.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h1 class="page-title">errors.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
5 changes: 2 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ <h2>Why?</h2><p>Metamon is a toolkit for consistency with the representations of
It provides methods for creating, indexing, manipulating, and maintaining consistency with the representations. </p>
<h2>Installation</h2><p>Metamon is available via <code>npm</code> for Node, for the Browser via CDN, and <code>bower</code></p>
<h4>jsDelivr CDN</h4><h5>Minified</h5><pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://cdn.jsdelivr.net/npm/metamon@2.0.0/dist/metamon.cjs.js&quot; integrity=&quot;sha256-i1uYcaeoV21xNqcjFyXpSaaHRc5o7unpCi+lPHmntA4=&quot; crossorigin=&quot;anonymous&quot;>&lt;/script></code></pre><h5>Un-Minified</h5><pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://cdn.jsdelivr.net/npm/metamon@2.0.0/dist/metamon.js&quot; integrity=&quot;sha256-W0RVLgpssC2x6SaACzqDiIa1Xo1L6L1vVmawPO9+2lE=&quot; crossorigin=&quot;anonymous&quot;>&lt;/script></code></pre><h5>CommonJS</h5><pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://cdn.jsdelivr.net/npm/metamon@2.0.0/dist/metamon.min.js&quot; integrity=&quot;sha256-yrlSk0MzJQD8GU0I0MYXnPUxrJ5Jxs6FvvYLLvpfht8=&quot; crossorigin=&quot;anonymous&quot;>&lt;/script></code></pre><h3>Node</h3><pre class="prettyprint source lang-shell"><code>npm i -S metamon</code></pre><h3>Browser</h3><p>You can install metamon via bower with:</p>
<pre class="prettyprint source lang-shell"><code>bower install metamon</code></pre><h2>Usage</h2><p>Read the <a href="https://justinbeaudry.github.io/metamon/">DOCS</a></p>
<h5>Minified</h5><pre class="prettyprint source lang-javascript"><code>const {Model, Collection, Enum} = require('metamon/dist/metamon.min.js');</code></pre><h5>Un-minified</h5><pre class="prettyprint source lang-javascript"><code>const {Model, Collection, Enum} = require('metamon/dist/metamon.js');</code></pre><h5>CommonJS</h5><pre class="prettyprint source lang-javascript"><code>const {Model, Collection, Enum} = require('metamon/dist/metamon.cjs.js');</code></pre><h3>Using in Redux</h3><p>Using ES6 Classes as state really don't play well with Redux. SEE: <a href="https://medium.com/collaborne-engineering/why-not-to-store-objects-in-redux-7f41243020fc">Why Not to Store Objects In Redux</a></p>
<pre class="prettyprint source lang-shell"><code>bower install metamon</code></pre><h3>Using in Redux</h3><p>Using ES6 Classes as state really don't play well with Redux. SEE: <a href="https://medium.com/collaborne-engineering/why-not-to-store-objects-in-redux-7f41243020fc">Why Not to Store Objects In Redux</a></p>
<pre class="prettyprint source lang-javascript"><code> import {Model} from 'metamon/index.es6.js';
class PersonCollection extends Model {}
// inside a reducer
Expand All @@ -81,7 +80,7 @@ <h5>Minified</h5><pre class="prettyprint source lang-javascript"><code>const {Mo
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:48:45 GMT-0700 (PDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Jul 28 2018 20:58:08 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down

0 comments on commit 305cd02

Please sign in to comment.