diff --git a/docs/howto/setup.rst b/docs/howto/setup.rst index e59ea90e7..b4fbc0372 100644 --- a/docs/howto/setup.rst +++ b/docs/howto/setup.rst @@ -3,6 +3,13 @@ Setup ===== +Installing into site-packages +----------------------------- + +If you need to manually install Django REST framework to your ``site-packages`` directory, run the ``setup.py`` script:: + + python setup.py install + Template Loaders ---------------- diff --git a/docs/howto/usingcurl.rst b/docs/howto/usingcurl.rst index e7edfef9f..2ad2c764d 100644 --- a/docs/howto/usingcurl.rst +++ b/docs/howto/usingcurl.rst @@ -23,4 +23,8 @@ There are a few things that can be helpful to remember when using CURL with djan #. Or any other content type:: - curl -X PUT -H 'Content-Type: application/json' --data-binary '{"foo":"bar"}' http://example.com/my-api/some-resource/ \ No newline at end of file + curl -X PUT -H 'Content-Type: application/json' --data-binary '{"foo":"bar"}' http://example.com/my-api/some-resource/ + +#. You can use basic authentication to send the username and password:: + + curl -X GET -H 'Accept: application/json' -u : http://example.com/my-api/ \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 3b4e9c49e..88c3bac2b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,15 +30,11 @@ Resources * The ``djangorestframework`` package is `available on PyPI `_. * We have an active `discussion group `_ and a `project blog `_. -* Bug reports are handled on the `issue tracker `_. +* Bug reports are handled on the `issue tracker `_. * There is a `Jenkins CI server `_ which tracks test status and coverage reporting. (Thanks Marko!) -* Get with in touch with `@thisneonsoul `_ on twitter. Any and all questions, thoughts, bug reports and contributions are *hugely appreciated*. -We'd like for this to be a real community driven effort, so come say hi, get involved, and get forking! (See: `Forking a Bitbucket Repository -`_, or `Fork A GitHub Repo `_) - Requirements ------------ @@ -46,8 +42,8 @@ Requirements * Django (1.2, 1.3 supported) -Installation & Setup --------------------- +Installation +------------ You can install Django REST framework using ``pip`` or ``easy_install``:: @@ -59,21 +55,17 @@ Or get the latest development version using mercurial or git:: hg clone https://bitbucket.org/tomchristie/django-rest-framework git clone git@github.com:tomchristie/django-rest-framework.git -Or you can download the current release: +Or you can `download the current release `_. -* `django-rest-framework-0.1.tar.gz `_ -* `django-rest-framework-0.1.zip `_ +Setup +----- -and then install Django REST framework to your ``site-packages`` directory, by running the ``setup.py`` script:: - - python setup.py install - -**To add django-rest-framework to a Django project:** +To add Django REST framework to a Django project: * Ensure that the ``djangorestframework`` directory is on your ``PYTHONPATH``. * Add ``djangorestframework`` to your ``INSTALLED_APPS``. -For more information take a look at the :ref:`setup` section. +For more information on settings take a look at the :ref:`setup` section. Getting Started ---------------