Update installation notes and credits

This commit is contained in:
Tom Christie 2012-09-03 12:20:08 +01:00
parent 5612109f71
commit 62efb742fe
2 changed files with 11 additions and 2 deletions

View File

@ -155,16 +155,20 @@ margin-top: 5px;
<p>The following packages are optional:</p> <p>The following packages are optional:</p>
<ul> <ul>
<li><a href="http://pypi.python.org/pypi/Markdown/">Markdown</a> (2.1.0+) - Markdown support for the self describing API.</li> <li><a href="http://pypi.python.org/pypi/Markdown/">Markdown</a> (2.1.0+) - Markdown support for the self describing API.</li>
<li><a href="http://pypi.python.org/pypi/PyYAML">PyYAML</a> (3.10+) - YAML content type support.</li> <li><a href="http://pypi.python.org/pypi/PyYAML">PyYAML</a> (3.10+) - YAML content-type support.</li>
</ul> </ul>
<h2 id="installation">Installation</h2> <h2 id="installation">Installation</h2>
<p><strong>WARNING: These instructions will only become valid once this becomes the master version</strong></p> <p><strong>WARNING: These instructions will only become valid once this becomes the master version</strong></p>
<p>Install using <code>pip</code>...</p> <p>Install using <code>pip</code>, including any optional packages you want...</p>
<pre><code>pip install djangorestframework <pre><code>pip install djangorestframework
pip install markdown # Recommended if using the browseable API.
pip install pyyaml # Required for yaml content-type support.
</code></pre> </code></pre>
<p>...or clone the project from github.</p> <p>...or clone the project from github.</p>
<pre><code>git clone git@github.com:tomchristie/django-rest-framework.git <pre><code>git clone git@github.com:tomchristie/django-rest-framework.git
cd django-rest-framework
pip install -r requirements.txt pip install -r requirements.txt
pip install -r optionals.txt
</code></pre> </code></pre>
<p>Add <code>djangorestframework</code> to your <code>INSTALLED_APPS</code>.</p> <p>Add <code>djangorestframework</code> to your <code>INSTALLED_APPS</code>.</p>
<pre><code>INSTALLED_APPS = ( <pre><code>INSTALLED_APPS = (

View File

@ -126,6 +126,7 @@ margin-top: 5px;
<div class="well affix span3"> <div class="well affix span3">
<ul class="nav nav-list side-nav"> <ul class="nav nav-list side-nav">
<li class="main"><a href="#credits">Credits</a></li> <li class="main"><a href="#credits">Credits</a></li>
<li><a href="#additional-thanks">Additional thanks</a></li>
<li><a href="#contact">Contact</a></li> <li><a href="#contact">Contact</a></li>
</ul> </ul>
@ -175,6 +176,10 @@ margin-top: 5px;
<li>Shawn Lewis <shawnlewis></li> <li>Shawn Lewis <shawnlewis></li>
</ul> </ul>
<p>Many thanks to everyone who's contributed to the project.</p> <p>Many thanks to everyone who's contributed to the project.</p>
<h2 id="additional-thanks">Additional thanks</h2>
<p>The documentation is built with <a href="http://twitter.github.com/bootstrap/">Bootstrap</a> and <a href="http://daringfireball.net/projects/markdown/">Markdown</a>.</p>
<p>Project hosting is with <a href="github.com/tomchristie/django-rest-framework">GitHub</a>.</p>
<p>Continuous integration testing is managed with <a href="https://secure.travis-ci.org/tomchristie/django-rest-framework">Travis CI</a>.</p>
<h2 id="contact">Contact</h2> <h2 id="contact">Contact</h2>
<p>To contact the author directly:</p> <p>To contact the author directly:</p>
<ul> <ul>