From 8b245fed14abff62a34e81f4ce8da1c396ba7712 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Mon, 2 Sep 2013 09:17:51 +0100
Subject: Add windows virtualenv activate instruction

Closes #1075.---
 docs/tutorial/quickstart.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index f15e75c0..06eec3c4 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -12,7 +12,7 @@ Create a new Django project named `tutorial`, then start a new app called `quick
 
     # Create a virtualenv to isolate our package dependencies locally
     virtualenv env
-    source env/bin/activate
+    source env/bin/activate  # On Windows use `env\Scripts\activate`
 
     # Install Django and Django REST framework into the virtualenv
     pip install django
-- 
cgit v1.2.3


From de6e7accef0f144f4bcae9618604d462b1d9d321 Mon Sep 17 00:00:00 2001
From: John Mee
Date: Mon, 23 Sep 2013 14:03:09 +1000
Subject: Mindnumbingly trivial single-char typo.

---
 docs/tutorial/quickstart.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 06eec3c4..80bb9abb 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -85,7 +85,7 @@ Right, we'd better write some views then.  Open `quickstart/views.py` and get ty
         queryset = Group.objects.all()
         serializer_class = GroupSerializer
 
-Rather that write multiple views we're grouping together all the common behavior into classes called `ViewSets`.
+Rather than write multiple views we're grouping together all the common behavior into classes called `ViewSets`.
 
 We can easily break these down into individual views if we need to, but using viewsets keeps the view logic nicely organized as well as being very concise.
 
-- 
cgit v1.2.3


From ca244ad614e2f6fb4fef1dc9987be996d2624303 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Fri, 13 Dec 2013 15:30:59 +0000
Subject: Expanded notes in quickstart.  Closes #1127.  Closes #1128.

---
 docs/tutorial/quickstart.md | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 80bb9abb..8bf8c7f5 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -89,6 +89,10 @@ Rather than write multiple views we're grouping together all the common behavior
 
 We can easily break these down into individual views if we need to, but using viewsets keeps the view logic nicely organized as well as being very concise.
 
+Notice that our viewset classes here are a little different from those in the [frontpage example][readme-example-api], as they include `queryset` and `serializer_class` attributes, instead of a `model` attribute.
+
+For trivial cases you can simply set a `model` attribute on the `ViewSet` class and the serializer and queryset will be automatically generated for you.  Setting the `queryset` and/or `serializer_class` attributes gives you more explicit control of the API behaviour, and is the recommended style for most applications.
+
 ## URLs
 
 Okay, now let's wire up the API URLs.  On to `tutorial/urls.py`...
@@ -169,6 +173,7 @@ Great, that was easy!
 
 If you want to get a more in depth understanding of how REST framework fits together head on over to [the tutorial][tutorial], or start browsing the [API guide][guide].
 
+[readme-example-api]: ../#example
 [image]: ../img/quickstart.png
 [tutorial]: 1-serialization.md
 [guide]: ../#api-guide
-- 
cgit v1.2.3


From 18eab53e892f2f579fd0bb4e1ca3cb47a074accc Mon Sep 17 00:00:00 2001
From: Emmanouil
Date: Wed, 9 Jul 2014 15:53:31 +0100
Subject: Updated quick start project set up order

---
 docs/tutorial/quickstart.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 8bf8c7f5..04792c69 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -6,8 +6,8 @@ We're going to create a simple API to allow admin users to view and edit the use
 
 Create a new Django project named `tutorial`, then start a new app called `quickstart`.
 
-    # Set up a new project
-    django-admin.py startproject tutorial
+	# Create the project directory
+	mkdir tutorial
     cd tutorial
 
     # Create a virtualenv to isolate our package dependencies locally
@@ -18,6 +18,9 @@ Create a new Django project named `tutorial`, then start a new app called `quick
     pip install django
     pip install djangorestframework
 
+    # Set up a new project
+    django-admin.py startproject tutorial
+
     # Create a new app
     python manage.py startapp quickstart
 
-- 
cgit v1.2.3


From 867e441ec07fc182569c3dbe6f86fe42aa6b0cbf Mon Sep 17 00:00:00 2001
From: sshquack
Date: Fri, 15 Aug 2014 20:45:28 -0600
Subject: Strip trailing spaces in tutorial

---
 docs/tutorial/quickstart.md | 38 +++++++++++++++++++-------------------
 1 file changed, 19 insertions(+), 19 deletions(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 8bf8c7f5..029b56a2 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -46,14 +46,14 @@ First up we're going to define some serializers in `quickstart/serializers.py` t
 
     from django.contrib.auth.models import User, Group
     from rest_framework import serializers
-    
-    
+
+
     class UserSerializer(serializers.HyperlinkedModelSerializer):
         class Meta:
             model = User
             fields = ('url', 'username', 'email', 'groups')
-    
-    
+
+
     class GroupSerializer(serializers.HyperlinkedModelSerializer):
         class Meta:
             model = Group
@@ -68,16 +68,16 @@ Right, we'd better write some views then.  Open `quickstart/views.py` and get ty
     from django.contrib.auth.models import User, Group
     from rest_framework import viewsets
     from quickstart.serializers import UserSerializer, GroupSerializer
-    
-    
+
+
     class UserViewSet(viewsets.ModelViewSet):
         """
         API endpoint that allows users to be viewed or edited.
         """
         queryset = User.objects.all()
         serializer_class = UserSerializer
-    
-    
+
+
     class GroupViewSet(viewsets.ModelViewSet):
         """
         API endpoint that allows groups to be viewed or edited.
@@ -144,22 +144,22 @@ We're now ready to test the API we've built.  Let's fire up the server from the
 
 We can now access our API, both from the command-line, using tools like `curl`...
 
-    bash: curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/ 
+    bash: curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
     {
-        "count": 2, 
-        "next": null, 
-        "previous": null, 
+        "count": 2,
+        "next": null,
+        "previous": null,
         "results": [
             {
-                "email": "admin@example.com", 
-                "groups": [], 
-                "url": "http://127.0.0.1:8000/users/1/", 
+                "email": "admin@example.com",
+                "groups": [],
+                "url": "http://127.0.0.1:8000/users/1/",
                 "username": "admin"
-            }, 
+            },
             {
-                "email": "tom@example.com", 
-                "groups": [                ], 
-                "url": "http://127.0.0.1:8000/users/2/", 
+                "email": "tom@example.com",
+                "groups": [                ],
+                "url": "http://127.0.0.1:8000/users/2/",
                 "username": "tom"
             }
         ]
-- 
cgit v1.2.3


From 61a1eaa4856dca3879010465fd0d60244450960e Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Mon, 18 Aug 2014 11:55:22 +0100
Subject: tabs -> spaces

---
 docs/tutorial/quickstart.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 0e60fa7c..98e5f439 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -6,8 +6,8 @@ We're going to create a simple API to allow admin users to view and edit the use
 
 Create a new Django project named `tutorial`, then start a new app called `quickstart`.
 
-	# Create the project directory
-	mkdir tutorial
+    # Create the project directory
+    mkdir tutorial
     cd tutorial
 
     # Create a virtualenv to isolate our package dependencies locally
-- 
cgit v1.2.3


From 9372cc8c31fc5d7b3fb3b155ed88b0b6d3c00049 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 20 Aug 2014 16:24:52 +0100
Subject: Deprecate .model attribute on views

---
 docs/tutorial/quickstart.md | 43 +++++++++++++++++--------------------------
 1 file changed, 17 insertions(+), 26 deletions(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 98e5f439..813e9872 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -18,34 +18,23 @@ Create a new Django project named `tutorial`, then start a new app called `quick
     pip install django
     pip install djangorestframework
 
-    # Set up a new project
-    django-admin.py startproject tutorial
-
-    # Create a new app
-    python manage.py startapp quickstart
-
-Next you'll need to get a database set up and synced.  If you just want to use SQLite for now, then you'll want to edit your `tutorial/settings.py` module to include something like this:
-
-    DATABASES = {
-        'default': {
-            'ENGINE': 'django.db.backends.sqlite3',
-            'NAME': 'database.sql',
-            'USER': '',
-            'PASSWORD': '',
-            'HOST': '',
-            'PORT': ''
-        }
-    }
+    # Set up a new project with a single application
+    django-admin.py startproject tutorial .
+    cd tutorial
+    django-admin.py startapp quickstart
+	cd ..
 
-The run `syncdb` like so:
+Now sync your database for the first time:
 
     python manage.py syncdb
 
+Make sure to create an initial user named `admin` with a password of `password`. We'll authenticate as that user later in our example.
+
 Once you've set up a database and got everything synced and ready to go, open up the app's directory and we'll get coding...
 
 ## Serializers
 
-First up we're going to define some serializers in `quickstart/serializers.py` that we'll use for our data representations.
+First up we're going to define some serializers. Let's create a new module named `tutorial/quickstart/serializers.py` that we'll use for our data representations.
 
     from django.contrib.auth.models import User, Group
     from rest_framework import serializers
@@ -66,11 +55,11 @@ Notice that we're using hyperlinked relations in this case, with `HyperlinkedMod
 
 ## Views
 
-Right, we'd better write some views then.  Open `quickstart/views.py` and get typing.
+Right, we'd better write some views then.  Open `tutorial/quickstart/views.py` and get typing.
 
     from django.contrib.auth.models import User, Group
     from rest_framework import viewsets
-    from quickstart.serializers import UserSerializer, GroupSerializer
+    from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
 
 
     class UserViewSet(viewsets.ModelViewSet):
@@ -100,9 +89,9 @@ For trivial cases you can simply set a `model` attribute on the `ViewSet` class
 
 Okay, now let's wire up the API URLs.  On to `tutorial/urls.py`...
 
-    from django.conf.urls import patterns, url, include
+    from django.conf.urls import url, include
     from rest_framework import routers
-    from quickstart import views
+    from tutorial.quickstart import views
 
     router = routers.DefaultRouter()
     router.register(r'users', views.UserViewSet)
@@ -110,10 +99,10 @@ Okay, now let's wire up the API URLs.  On to `tutorial/urls.py`...
 
     # Wire up our API using automatic URL routing.
     # Additionally, we include login URLs for the browseable API.
-    urlpatterns = patterns('',
+    urlpatterns = [
         url(r'^', include(router.urls)),
         url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
-    )
+    ]
 
 Because we're using viewsets instead of views, we can automatically generate the URL conf for our API, by simply registering the viewsets with a router class.
 
@@ -172,6 +161,8 @@ Or directly through the browser...
 
 ![Quick start image][image]
 
+If you're working through the browser, make sure to login using the control in the top right corner.
+
 Great, that was easy!
 
 If you want to get a more in depth understanding of how REST framework fits together head on over to [the tutorial][tutorial], or start browsing the [API guide][guide].
-- 
cgit v1.2.3


From 5d247a65c89594a7ab5ce2333612f23eadc6828d Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Thu, 9 Oct 2014 15:11:19 +0100
Subject: First pass on nested serializers in HTML

---
 docs/tutorial/quickstart.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 813e9872..c2dc4bea 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -26,11 +26,13 @@ Create a new Django project named `tutorial`, then start a new app called `quick
 
 Now sync your database for the first time:
 
-    python manage.py syncdb
+    python manage.py migrate
 
-Make sure to create an initial user named `admin` with a password of `password`. We'll authenticate as that user later in our example.
+We'll also create an initial user named `admin` with a password of `password`. We'll authenticate as that user later in our example.
 
-Once you've set up a database and got everything synced and ready to go, open up the app's directory and we'll get coding...
+    python manage.py createsuperuser
+
+Once you've set up a database and initial user created and ready to go, open up the app's directory and we'll get coding...
 
 ## Serializers
 
-- 
cgit v1.2.3


From 928cbc640ef1db2c3fb96d352f69b8ffb66313e6 Mon Sep 17 00:00:00 2001
From: Raony Guimarães
Date: Wed, 19 Nov 2014 13:53:36 -0200
Subject: small type

---
 docs/tutorial/quickstart.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index c2dc4bea..1c398c1f 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -19,7 +19,7 @@ Create a new Django project named `tutorial`, then start a new app called `quick
     pip install djangorestframework
 
     # Set up a new project with a single application
-    django-admin.py startproject tutorial .
+    django-admin.py startproject tutorial
     cd tutorial
     django-admin.py startapp quickstart
 	cd ..
-- 
cgit v1.2.3


From e2ea98e8ab3192fa8d252d33cc03929fcf6ed02f Mon Sep 17 00:00:00 2001
From: Tymur Maryokhin
Date: Sat, 29 Nov 2014 20:23:55 +0100
Subject: Fixed typos

---
 docs/tutorial/quickstart.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 1c398c1f..3e1ce0a9 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -100,7 +100,7 @@ Okay, now let's wire up the API URLs.  On to `tutorial/urls.py`...
     router.register(r'groups', views.GroupViewSet)
 
     # Wire up our API using automatic URL routing.
-    # Additionally, we include login URLs for the browseable API.
+    # Additionally, we include login URLs for the browsable API.
     urlpatterns = [
         url(r'^', include(router.urls)),
         url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
-- 
cgit v1.2.3


From 34b5db62e560e73516fb569eaf9b71ea5562958f Mon Sep 17 00:00:00 2001
From: phalt
Date: Mon, 1 Dec 2014 13:39:53 +0000
Subject: Use httpie for tutorials

---
 docs/tutorial/quickstart.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 1c398c1f..41e864cc 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -24,6 +24,10 @@ Create a new Django project named `tutorial`, then start a new app called `quick
     django-admin.py startapp quickstart
 	cd ..
 
+Optionally, install [httpie][httpie] for tastier HTTP requests:
+
+    pip install httpie
+
 Now sync your database for the first time:
 
     python manage.py migrate
@@ -159,6 +163,30 @@ We can now access our API, both from the command-line, using tools like `curl`..
         ]
     }
 
+Or with [httpie][httpie], a tastier version of `curl`...
+
+    bash: http -a username:password http://127.0.0.1:8000/users/ --body
+    {
+        "count": 2,
+        "next": null,
+        "previous": null,
+        "results": [
+            {
+                "email": "admin@example.com",
+                "groups": [],
+                "url": "http://localhost:8000/users/1/",
+                "username": "paul"
+            },
+            {
+                "email": "tom@example.com",
+                "groups": [                ],
+                "url": "http://127.0.0.1:8000/users/2/",
+                "username": "tom"
+            }
+        ]
+    }
+
+
 Or directly through the browser...
 
 ![Quick start image][image]
@@ -173,3 +201,4 @@ If you want to get a more in depth understanding of how REST framework fits toge
 [image]: ../img/quickstart.png
 [tutorial]: 1-serialization.md
 [guide]: ../#api-guide
+[httpie]: https://github.com/jakubroztocil/httpie#installation
-- 
cgit v1.2.3


From fcbae5d99f93a28c9aac340bf2d4d2a3930e1a6a Mon Sep 17 00:00:00 2001
From: phalt
Date: Thu, 4 Dec 2014 11:20:33 +0000
Subject: updates based on suggestions

---
 docs/tutorial/quickstart.md | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 41e864cc..43220ce8 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -24,10 +24,6 @@ Create a new Django project named `tutorial`, then start a new app called `quick
     django-admin.py startapp quickstart
 	cd ..
 
-Optionally, install [httpie][httpie] for tastier HTTP requests:
-
-    pip install httpie
-
 Now sync your database for the first time:
 
     python manage.py migrate
@@ -163,9 +159,12 @@ We can now access our API, both from the command-line, using tools like `curl`..
         ]
     }
 
-Or with [httpie][httpie], a tastier version of `curl`...
+Or using the [httpie][httpie], command line tool...
+
+    bash: http -a username:password http://127.0.0.1:8000/users/
 
-    bash: http -a username:password http://127.0.0.1:8000/users/ --body
+    HTTP/1.1 200 OK
+    ...
     {
         "count": 2,
         "next": null,
-- 
cgit v1.2.3


From e2b39088345e564a06ce332b740215600c29e481 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Fri, 5 Dec 2014 09:44:01 +0000
Subject: Fix quickstart tutorial

---
 docs/tutorial/quickstart.md | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 3e1ce0a9..d0703381 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -19,10 +19,9 @@ Create a new Django project named `tutorial`, then start a new app called `quick
     pip install djangorestframework
 
     # Set up a new project with a single application
-    django-admin.py startproject tutorial
+    django-admin.py startproject tutorial .
     cd tutorial
     django-admin.py startapp quickstart
-	cd ..
 
 Now sync your database for the first time:
 
-- 
cgit v1.2.3


From 4e9ebb5fe9eee2ef6f21718d9becfb8e94bbbe98 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Mon, 8 Dec 2014 16:38:17 +0000
Subject: cd back to parent directory

---
 docs/tutorial/quickstart.md | 1 +
 1 file changed, 1 insertion(+)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index d0703381..f72fc7dd 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -22,6 +22,7 @@ Create a new Django project named `tutorial`, then start a new app called `quick
     django-admin.py startproject tutorial .
     cd tutorial
     django-admin.py startapp quickstart
+    cd ..
 
 Now sync your database for the first time:
 
-- 
cgit v1.2.3


From 1ba822010d0943c67c127f3f62e873b64348ef87 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 17 Dec 2014 15:22:27 +0000
Subject: Highlight trailing '.' in command so it wont be missed.

---
 docs/tutorial/quickstart.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index c3f95994..a4474c34 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -19,7 +19,7 @@ Create a new Django project named `tutorial`, then start a new app called `quick
     pip install djangorestframework
 
     # Set up a new project with a single application
-    django-admin.py startproject tutorial .
+    django-admin.py startproject tutorial .  # Note the trailing '.' character
     cd tutorial
     django-admin.py startapp quickstart
     cd ..
-- 
cgit v1.2.3


From 18cc0230bff436da2f26b2b25034cece32c9f5d0 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 4 Mar 2015 15:51:00 +0000
Subject: Clean up pagination attributes

---
 docs/tutorial/quickstart.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/tutorial/quickstart.md')

diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index a4474c34..fe0ecbc7 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -123,7 +123,7 @@ We'd also like to set a few global settings.  We'd like to turn on pagination, a
 
     REST_FRAMEWORK = {
         'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAdminUser',),
-        'PAGINATE_BY': 10
+        'PAGE_SIZE': 10
     }
 
 Okay, we're done.
-- 
cgit v1.2.3