From a61725f98d120603d674e4a7672aefbe13469d49 Mon Sep 17 00:00:00 2001 From: Jib Date: Mon, 13 Jan 2025 17:50:55 -0500 Subject: [PATCH 1/3] Create README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e24483 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Django MongoDB 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`: + +* Find you Django version. +* Based on your Django version, provide that in the link defined below. + +`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 template that works with `django==5.0.*` + +`django-admin startproject 5_0_example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip` From 6636f9300545677a0c7ba9e64a75bc3834391b50 Mon Sep 17 00:00:00 2001 From: Jib Date: Mon, 13 Jan 2025 17:53:02 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8e24483..81526b0 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,20 @@ This is the starter template for the Django-MongoDB Backend. In order to use, with your version of `django-mongodb-backend` and `django`: -* Find you Django version. +* Find your Django version. * Based on your Django version, provide that in the link defined below. -`django-admin startproject {{ project_name }} --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/{{ version }}.x.zip` +## Create the Django Project +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 template that works with `django==5.0.*` +For a project name `5_0_exmaple` that runs on `django==5.0.*`: -`django-admin startproject 5_0_example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip` +```bash +django-admin startproject 5_0_example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip +``` From 83d62efa060c78786988522ca35fd2fe0613d88a Mon Sep 17 00:00:00 2001 From: Jib Date: Mon, 13 Jan 2025 17:54:43 -0500 Subject: [PATCH 3/3] Update README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 81526b0..aa6f5f2 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,13 @@ This is the starter template for the Django-MongoDB Backend. In order to use, with your version of `django-mongodb-backend` and `django`: -* Find your Django version. -* Based on your Django version, provide that in the link defined below. +* Find your Django version. To do so from the command line, make sure you have django installed and type: + +```bash +django-admin --version +>> 5.0 +``` + ## Create the Django Project From your shell, run the following command to create a new Django project replacing the `{{ project_name }}` and `{{ version }}` sections.