README, examples: add django_spanner as first entry into INSTALLED_APPS

odeke-em · odeke-em · commit 4b5a79192958 · 2020-04-24T15:52:41.000-07:00
Also while here, fixed a typo in a setting field for `DATABASES` that used DATABASE instead of NAME for the name of the database. Fixes #433
diff --git a/packages/django-google-spanner/README.md b/packages/django-google-spanner/README.md
@@ -36,8 +36,17 @@ pip3 install --user .
 ```
 
 ## Using it
-After [installing it](#installing-it), you'll need to edit your Django `settings.py` file
-and particularly the `DATABASES` section to point to an EXISTING database, of the format:
+After [installing it](#installing-it), you'll need to edit your Django `settings.py` file:
+
+* Add `django_spanner` as the very first entry in the `INSTALLED_APPS` setting
+```python
+INSTALLED_APPS = [
+    'django_spanner',
+    ...
+]
+```
+
+* Edit the `DATABASES` setting to point to an EXISTING database
 
 ### Format
 
@@ -66,7 +75,7 @@ DATABASES = {
         'ENGINE': 'django_spanner',
         'PROJECT': 'appdev-soda-spanner-staging', # Or the GCP project-id
         'INSTANCE': 'django-dev1', # Or the Cloud Spanner instance
-        'DATABASE': 'db1', # Or the Cloud Spanner database to use
+        'NAME': 'db1', # Or the Cloud Spanner database to use
     }
 }
 ```
diff --git a/packages/django-google-spanner/examples/from-scratch/README.md b/packages/django-google-spanner/examples/from-scratch/README.md
@@ -26,7 +26,17 @@ After we have a Cloud Spanner database created, we'll need a few variables:
 * Instance name
 * Database name aka DisplayName
 
-Once in, please edit the file `hc/local_settings.py` and make the section `DATABASES` into the following:
+Once in, please edit the file `hc/local_settings.py`, and:
+
+a) add `django_spanner` as the very first entry to your `INSTALLED_APPS`
+```python
+INSTALLED_APPS = [
+    'django_spanner',  # Must be listed first.
+    ...
+]
+```
+
+b) update `DATABASES` into the following:
 ```python
 DATABASES = {
     'default': {
@@ -57,7 +67,6 @@ DATABASES = {
 }
 ```
 
-
 ### Apply the migrations
 Please run:
 ```shell
diff --git a/packages/django-google-spanner/examples/healthchecks/README.md b/packages/django-google-spanner/examples/healthchecks/README.md
@@ -61,7 +61,18 @@ After we have a Cloud Spanner database created, we'll need a few variables:
 * Instance name
 * Database name aka DisplayName
 
-Once in, please edit the file `hc/local_settings.py` and make the section `DATABASES` into the following:
+Once in, please edit the file `hc/local_settings.py` to:
+a) Add `django_spanner` as the first entry to `INSTALLED_APPS`
+```python
+INSTALLED_APPS = [
+    'django_spanner',  # Must be listed first.
+    ...
+]
+```
+**The rest of the apps MUST be copied from hc/settings.py**
+
+
+b) Edit `DATABASES` into the following:
 ```python
 DATABASES = {
     'default': {
