Skip to content

Commit

Permalink
Update documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyckahn committed Mar 20, 2016
1 parent 888648b commit 5062f67
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ <h1>Keydrown</h1>
<h2>A JavaScript key state handler for web apps</h2>
<p>Keydrown is a library for managing the state of the keyboard in a web application or game. It is tiny (about .5Kb), unobtrusive and can be learned in about five minutes.</p>
<ul>
<li><a href="dist/doc/src/kd.key.js.html">API documentation</a></li>
<li><a href="dist/doc">API documentation</a></li>
</ul>
<h3>Why is Keydrown useful?</h3>
<p>When you bind a function to the <code>keydown</code> event, it doesn't fire consistently. The web browser uses the operating system's built-in keyboard delay preferences, and the first brief moment after the initial key press does not invoke the event handler. Here's a demonstration of native behavior:</p>
Expand Down Expand Up @@ -54,7 +54,7 @@ <h3>How do I use Keydrown?</h3>
<li><a href="dist/keydrown.js">keydrown.js</a></li>
<li><a href="dist/keydrown.min.js">keydrown.min.js</a></li>
</ul>
<p>All of the Keydrown APIs live under the <code>kd</code> namespace. Keydrown is tick-based, so you'll need to call <a href="dist/doc/src/kd.core.js.html#tick"><code>kd.tick()</code></a> somewhere in your run loop. For your convenience, Keydrown provides <a href="dist/doc/src/kd.core.js.html#run"><code>kd.run()</code></a> for a basic run loop if you don't already have one.</p>
<p>All of the Keydrown APIs live under the <code>kd</code> namespace. Keydrown is tick-based, so you'll need to call <a href="dist/doc/classes/kd.html#method_tick"><code>kd.tick()</code></a> somewhere in your run loop. For your convenience, Keydrown provides <a href="dist/doc/classes/kd.html#method_run"><code>kd.run()</code></a> for a basic run loop if you don't already have one.</p>
<pre>
kd.run(function () {
kd.tick();
Expand Down

0 comments on commit 5062f67

Please sign in to comment.