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

@ -101,3 +101,17 @@ Then, to use Mithril, point a script tag to the downloaded file:
```markup
<script src="/components/lhorie/mithril/master/mithril.min.js"></script>
```
---
### Github
You can also fork the latest stable project [directly from Github](https://github.com/lhorie/mithril).
If you want to use the bleeding edge version, you can [fork the development repository](https://github.com/lhorie/mithril).
Note that Mithril uses the `next` branch as the stable branch, instead of `master`, because contributors usually use `master` for pull requests. Therefore, the `master` branch should be considered unstable, and should not be used.
Be aware that even though Mithril has tests running in a continuous integration environment, the bleeding edge version might occasionally break. If you're interested in helping improve Mithril, you're welcome to use the bleeding edge version and report any bugs that you find.
In order to update a forked version of Mithril, [follow the instructions on this page](https://help.github.com/articles/syncing-a-fork).