add docs about github

This commit is contained in:
Leo Horie 2014-04-10 22:07:32 -04:00
parent 5c9f9d782f
commit 7d0ba8401f
3 changed files with 21 additions and 0 deletions

View file

@ -85,6 +85,13 @@
<pre><code>component install lhorie/mithril</code></pre>
<p>Then, to use Mithril, point a script tag to the downloaded file:</p>
<pre><code class="lang-markup">&lt;script src=&quot;/components/lhorie/mithril/master/mithril.min.js&quot;&gt;&lt;/script&gt;</code></pre>
<hr>
<h3 id="github">Github</h3>
<p>You can also fork the latest stable project <a href="https://github.com/lhorie/mithril">directly from Github</a>.</p>
<p>If you want to use the bleeding edge version, you can <a href="https://github.com/lhorie/mithril">fork the development repository</a>.</p>
<p>Note that Mithril uses the <code>next</code> branch as the stable branch, instead of <code>master</code>, because contributors usually use <code>master</code> for pull requests. Therefore, the <code>master</code> branch should be considered unstable, and should not be used.</p>
<p>Be aware that even though Mithril has tests running in a continuous integration environment, the bleeding edge version might occasionally break. If you&#39;re interested in helping improve Mithril, you&#39;re welcome to use the bleeding edge version and report any bugs that you find.</p>
<p>In order to update a forked version of Mithril, <a href="https://help.github.com/articles/syncing-a-fork">follow the instructions on this page</a>.</p>
</div>
</div>

Binary file not shown.