diff --git a/README.md b/README.md index aa6f5f2..39e61f0 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,27 @@ -# Django MongoDB Project Template +# Django MongoDB Backend - Project Template -This is the starter template for the Django-MongoDB Backend. In order to use, with your version of `django-mongodb-backend` and `django`: +This is a Django project starter template for the Django MongoDB Backend. +In order to use it with your version of Django: -* Find your Django version. To do so from the command line, make sure you have django installed and type: +- Find your Django version. To do so from the command line, make sure you + have Django installed and run: ```bash django-admin --version >> 5.0 ``` +## Create the Django project -## Create the Django Project -From your shell, run the following command to create a new Django project replacing the `{{ project_name }}` and `{{ version }}` sections. +From your shell, run the following command to create a new Django project +replacing the `{{ project_name }}` and `{{ version }}` sections. ```bash django-admin startproject {{ project_name }} --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/{{ version }}.x.zip ``` -Below is an example: - -For a project name `5_0_exmaple` that runs on `django==5.0.*`: +For a project named `5_0_example` that runs on `django==5.0.*` +the command would look like this: ```bash django-admin startproject 5_0_example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip