mirror of
				https://github.com/encode/django-rest-framework.git
				synced 2025-10-31 16:07:38 +03:00 
			
		
		
		
	Update installation notes and credits
This commit is contained in:
		
							parent
							
								
									5612109f71
								
							
						
					
					
						commit
						62efb742fe
					
				|  | @ -155,16 +155,20 @@ margin-top: 5px; | |||
| <p>The following packages are optional:</p> | ||||
| <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/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> | ||||
| <h2 id="installation">Installation</h2> | ||||
| <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 | ||||
| pip install markdown  # Recommended if using the browseable API. | ||||
| pip install pyyaml    # Required for yaml content-type support. | ||||
| </code></pre> | ||||
| <p>...or clone the project from github.</p> | ||||
| <pre><code>git clone git@github.com:tomchristie/django-rest-framework.git | ||||
| cd django-rest-framework | ||||
| pip install -r requirements.txt | ||||
| pip install -r optionals.txt | ||||
| </code></pre> | ||||
| <p>Add <code>djangorestframework</code> to your <code>INSTALLED_APPS</code>.</p> | ||||
| <pre><code>INSTALLED_APPS = ( | ||||
|  |  | |||
|  | @ -126,6 +126,7 @@ margin-top: 5px; | |||
|             <div class="well affix span3"> | ||||
|               <ul class="nav nav-list side-nav"> | ||||
| <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> | ||||
| 
 | ||||
|               </ul> | ||||
|  | @ -175,6 +176,10 @@ margin-top: 5px; | |||
| <li>Shawn Lewis <shawnlewis></li> | ||||
| </ul> | ||||
| <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> | ||||
| <p>To contact the author directly:</p> | ||||
| <ul> | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue
	
	Block a user