Skip to content

Commit 9be1767

Browse files
authored
Readme fixes (#8)
1 parent fb6d64e commit 9be1767

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
1-
# Django MongoDB Project Template
1+
# Django MongoDB Backend - Project Template
22

3-
This is the starter template for the Django-MongoDB Backend. In order to use, with your version of `django-mongodb-backend` and `django`:
3+
This is a Django project starter template for the Django MongoDB Backend.
4+
In order to use it with your version of Django:
45

5-
* Find your Django version. To do so from the command line, make sure you have django installed and type:
6+
- Find your Django version. To do so from the command line, make sure you
7+
have Django installed and run:
68

79
```bash
810
django-admin --version
911
>> 5.0
1012
```
1113

14+
## Create the Django project
1215

13-
## Create the Django Project
14-
From your shell, run the following command to create a new Django project replacing the `{{ project_name }}` and `{{ version }}` sections.
16+
From your shell, run the following command to create a new Django project
17+
replacing the `{{ project_name }}` and `{{ version }}` sections.
1518

1619
```bash
1720
django-admin startproject {{ project_name }} --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/{{ version }}.x.zip
1821
```
1922

20-
Below is an example:
21-
22-
For a project name `5_0_exmaple` that runs on `django==5.0.*`:
23+
For a project named `5_0_example` that runs on `django==5.0.*`
24+
the command would look like this:
2325

2426
```bash
2527
django-admin startproject 5_0_example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip

0 commit comments

Comments
 (0)