Skip to content

Commit

Permalink
Fixing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lmaccherone
lmaccherone committed Dec 15, 2015
1 parent 13681f6 commit 95600dd
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 15 deletions.
9 changes: 5 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Documentation](https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/Lumenize-docs/index.html)
# [Documentation](https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/Lumenize-docs/index.html)

[![build status](https://secure.travis-ci.org/lmaccherone/Lumenize.svg)](http://travis-ci.org/lmaccherone/Lumenize)
[![NPM version](https://badge.fury.io/js/lumenize.svg)](http://badge.fury.io/js/Lumenize)
Expand All @@ -16,7 +16,7 @@ Lumenize is a collection of tools for analyzing and making awesome visualization

## Documentation and source code ##

* [API Documentation](https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/lumenize-docs/index.html)
* [API Documentation](https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/lumenize-docs/index.html)
* [Source Repository](https://github.com/lmaccherone/Lumenize)

## Features ##
Expand All @@ -30,7 +30,7 @@ Lumenize is a collection of tools for analyzing and making awesome visualization
* Bundled with the [tzTime](https://github.com/lmaccherone/tzTime) library (same author) for
timezone precise x-axis. Knockout weekends, holidays, non-work hours, etc.
* Tested - Over 600 tests (plus over 400 tests in tzTime)
* [Documented (Lumenize)](https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/lumenize-docs/index.html) [(tzTime)](http://lmaccherone.github.com/tzTime/docs/tztime-docs/index.html) - Robust documentation and examples
* [Documented (Lumenize)](https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/lumenize-docs/index.html) [(tzTime)](http://lmaccherone.github.com/tzTime/docs/tztime-docs/index.html) - Robust documentation and examples
* [DocTested](https://github.com/lmaccherone/coffeedoctest) - The examples will always match
the code because it fails automated testing when they don't

Expand All @@ -49,7 +49,7 @@ To use in a browser, either host it on your own site, or if your volume is low e

Replace `{{version}}` with the version of Lumenize you wish to use (probably the latest). See the Changelog section for information about versions. Example:

`<script type="text/javascript" src="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/deploy/lumenize-min.js"></script>`
`<script type="text/javascript" src="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/deploy/lumenize-min.js"></script>`

The package is fairly large ~260KB but most of that is the embedded timezone files which compress really well.

Expand All @@ -73,6 +73,7 @@ Then in your code:

## Changelog ##

* 1.0.3 - 2015-12-14 - Still trying to fix caching
* 1.0.2 - 2015-12-14 - Fixing CDN caching of old docs
* 1.0.1 - 2015-12-14 - Switched from googleapis CDN to rawgit because publishing to googleapis has been troublesome
* 1.0.0 - 2015-12-14 - **Backward breaking** UniqueIDField now defaults to "_EntityID" to match with Temporalize.
Expand Down
2 changes: 1 addition & 1 deletion bower.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "lumenize",
"version": "1.0.2",
"version": "1.0.3",
"homepage": "https://github.com/lmaccherone/Lumenize",
"authors": [
"Larry Maccherone"
Expand Down
2 changes: 1 addition & 1 deletion deploy/lumenize.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
lumenize version: 1.0.2
lumenize version: 1.0.3
*/
var require = function (file, cwd) {
var resolved = require.resolve(file, cwd || '/');
Expand Down
9 changes: 5 additions & 4 deletions docs/README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
</style>
<body>
<div class="readme">
<h1 id="-documentation-https-cdn-rawgit-com-lmaccherone-lumenize-v1-0-2-docs-lumenize-docs-index-html-"><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/Lumenize-docs/index.html">Documentation</a></h1>
<h1 id="-documentation-https-cdn-rawgit-com-lmaccherone-lumenize-v1-0-3-docs-lumenize-docs-index-html-"><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/Lumenize-docs/index.html">Documentation</a></h1>
<p><a href="http://travis-ci.org/lmaccherone/Lumenize"><img src="https://secure.travis-ci.org/lmaccherone/Lumenize.svg" alt="build status"></a>
<a href="http://badge.fury.io/js/Lumenize"><img src="https://badge.fury.io/js/lumenize.svg" alt="NPM version"></a>
<a href="https://david-dm.org/lmaccherone/Lumenize"><img src="https://david-dm.org/lmaccherone/Lumenize.svg" alt="build status"></a>
Expand All @@ -90,7 +90,7 @@ <h1 id="lumenize">Lumenize</h1>
<p>Lumenize is a collection of tools for analyzing and making awesome visualizations out of your data.</p>
<h2 id="documentation-and-source-code">Documentation and source code</h2>
<ul>
<li><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/lumenize-docs/index.html">API Documentation</a></li>
<li><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/lumenize-docs/index.html">API Documentation</a></li>
<li><a href="https://github.com/lmaccherone/Lumenize">Source Repository</a></li>
</ul>
<h2 id="features">Features</h2>
Expand All @@ -106,7 +106,7 @@ <h2 id="features">Features</h2>
<li>Bundled with the <a href="https://github.com/lmaccherone/tzTime">tzTime</a> library (same author) for
timezone precise x-axis. Knockout weekends, holidays, non-work hours, etc.</li>
<li>Tested - Over 600 tests (plus over 400 tests in tzTime)</li>
<li><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/lumenize-docs/index.html">Documented (Lumenize)</a> <a href="http://lmaccherone.github.com/tzTime/docs/tztime-docs/index.html">(tzTime)</a> - Robust documentation and examples</li>
<li><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/lumenize-docs/index.html">Documented (Lumenize)</a> <a href="http://lmaccherone.github.com/tzTime/docs/tztime-docs/index.html">(tzTime)</a> - Robust documentation and examples</li>
<li><a href="https://github.com/lmaccherone/coffeedoctest">DocTested</a> - The examples will always match
the code because it fails automated testing when they don&#39;t</li>
</ul>
Expand All @@ -120,7 +120,7 @@ <h2 id="usage-in-a-browser">Usage in a browser</h2>
<p>To use in a browser, either host it on your own site, or if your volume is low enough, you can directly hit the github pages for the deploy version:</p>
<p><code>&lt;script type=&quot;text/javascript&quot; src=&quot;https://cdn.rawgit.com/lmaccherone/Lumenize/v{{version}}/deploy/lumenize-min.js&quot;&gt;&lt;/script&gt;</code></p>
<p>Replace <code>{{version}}</code> with the version of Lumenize you wish to use (probably the latest). See the Changelog section for information about versions. Example:</p>
<p><code>&lt;script type=&quot;text/javascript&quot; src=&quot;https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/deploy/lumenize-min.js&quot;&gt;&lt;/script&gt;</code></p>
<p><code>&lt;script type=&quot;text/javascript&quot; src=&quot;https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/deploy/lumenize-min.js&quot;&gt;&lt;/script&gt;</code></p>
<p>The package is fairly large ~260KB but most of that is the embedded timezone files which compress really well.</p>
<p>Then at the top of the javascript where you want to call it, put the following:</p>
<p><code>var lumenize = require(&#39;./lumenize&#39;);</code></p>
Expand All @@ -133,6 +133,7 @@ <h2 id="usage-in-node-js">Usage in node.js</h2>
<p><code>var lumenize = require(&#39;lumenize&#39;)</code></p>
<h2 id="changelog">Changelog</h2>
<ul>
<li>1.0.3 - 2015-12-14 - Still trying to fix caching </li>
<li>1.0.2 - 2015-12-14 - Fixing CDN caching of old docs </li>
<li>1.0.1 - 2015-12-14 - Switched from googleapis CDN to rawgit because publishing to googleapis has been troublesome </li>
<li>1.0.0 - 2015-12-14 - <strong>Backward breaking</strong> UniqueIDField now defaults to &quot;_EntityID&quot; to match with Temporalize.
Expand Down
9 changes: 5 additions & 4 deletions docs/lumenize-docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
</style>
<body>
<div class="readme">
<h1 id="-documentation-https-cdn-rawgit-com-lmaccherone-lumenize-v1-0-2-docs-lumenize-docs-index-html-"><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/Lumenize-docs/index.html">Documentation</a></h1>
<h1 id="-documentation-https-cdn-rawgit-com-lmaccherone-lumenize-v1-0-3-docs-lumenize-docs-index-html-"><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/Lumenize-docs/index.html">Documentation</a></h1>
<p><a href="http://travis-ci.org/lmaccherone/Lumenize"><img src="https://secure.travis-ci.org/lmaccherone/Lumenize.svg" alt="build status"></a>
<a href="http://badge.fury.io/js/Lumenize"><img src="https://badge.fury.io/js/lumenize.svg" alt="NPM version"></a>
<a href="https://david-dm.org/lmaccherone/Lumenize"><img src="https://david-dm.org/lmaccherone/Lumenize.svg" alt="build status"></a>
Expand All @@ -117,7 +117,7 @@ <h1 id="lumenize">Lumenize</h1>
<p>Lumenize is a collection of tools for analyzing and making awesome visualizations out of your data.</p>
<h2 id="documentation-and-source-code">Documentation and source code</h2>
<ul>
<li><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/lumenize-docs/index.html">API Documentation</a></li>
<li><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/lumenize-docs/index.html">API Documentation</a></li>
<li><a href="https://github.com/lmaccherone/Lumenize">Source Repository</a></li>
</ul>
<h2 id="features">Features</h2>
Expand All @@ -133,7 +133,7 @@ <h2 id="features">Features</h2>
<li>Bundled with the <a href="https://github.com/lmaccherone/tzTime">tzTime</a> library (same author) for
timezone precise x-axis. Knockout weekends, holidays, non-work hours, etc.</li>
<li>Tested - Over 600 tests (plus over 400 tests in tzTime)</li>
<li><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/docs/lumenize-docs/index.html">Documented (Lumenize)</a> <a href="http://lmaccherone.github.com/tzTime/docs/tztime-docs/index.html">(tzTime)</a> - Robust documentation and examples</li>
<li><a href="https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/docs/lumenize-docs/index.html">Documented (Lumenize)</a> <a href="http://lmaccherone.github.com/tzTime/docs/tztime-docs/index.html">(tzTime)</a> - Robust documentation and examples</li>
<li><a href="https://github.com/lmaccherone/coffeedoctest">DocTested</a> - The examples will always match
the code because it fails automated testing when they don&#39;t</li>
</ul>
Expand All @@ -147,7 +147,7 @@ <h2 id="usage-in-a-browser">Usage in a browser</h2>
<p>To use in a browser, either host it on your own site, or if your volume is low enough, you can directly hit the github pages for the deploy version:</p>
<p><code>&lt;script type=&quot;text/javascript&quot; src=&quot;https://cdn.rawgit.com/lmaccherone/Lumenize/v{{version}}/deploy/lumenize-min.js&quot;&gt;&lt;/script&gt;</code></p>
<p>Replace <code>{{version}}</code> with the version of Lumenize you wish to use (probably the latest). See the Changelog section for information about versions. Example:</p>
<p><code>&lt;script type=&quot;text/javascript&quot; src=&quot;https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.2/deploy/lumenize-min.js&quot;&gt;&lt;/script&gt;</code></p>
<p><code>&lt;script type=&quot;text/javascript&quot; src=&quot;https://cdn.rawgit.com/lmaccherone/Lumenize/v1.0.3/deploy/lumenize-min.js&quot;&gt;&lt;/script&gt;</code></p>
<p>The package is fairly large ~260KB but most of that is the embedded timezone files which compress really well.</p>
<p>Then at the top of the javascript where you want to call it, put the following:</p>
<p><code>var lumenize = require(&#39;./lumenize&#39;);</code></p>
Expand All @@ -160,6 +160,7 @@ <h2 id="usage-in-node-js">Usage in node.js</h2>
<p><code>var lumenize = require(&#39;lumenize&#39;)</code></p>
<h2 id="changelog">Changelog</h2>
<ul>
<li>1.0.3 - 2015-12-14 - Still trying to fix caching </li>
<li>1.0.2 - 2015-12-14 - Fixing CDN caching of old docs </li>
<li>1.0.1 - 2015-12-14 - Switched from googleapis CDN to rawgit because publishing to googleapis has been troublesome </li>
<li>1.0.0 - 2015-12-14 - <strong>Backward breaking</strong> UniqueIDField now defaults to &quot;_EntityID&quot; to match with Temporalize.
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "lumenize",
"version": "1.0.2",
"version": "1.0.3",
"main": "./lumenize",
"description": "Illuminating the forest AND the trees in your data.",
"keywords": [
Expand Down

0 comments on commit 95600dd

Please sign in to comment.