Skip to content

Commit a24e963

Browse files
committed
Cleanup README (wrap lines, clarify docs, remove list of features)
1 parent 94eefad commit a24e963

File tree

1 file changed

+33
-51
lines changed

1 file changed

+33
-51
lines changed

README.md

Lines changed: 33 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,41 @@
11
# Django MongoDB Backend
22

3-
## Index
4-
* [Documentation](https://www.mongodb.com/docs/languages/python/django-mongodb/current/)
5-
* [Getting Started](https://www.mongodb.com/docs/languages/python/django-mongodb/current/get-started/)
6-
* [Model Your Data](https://www.mongodb.com/docs/languages/python/django-mongodb/current/model-data/)
7-
* [Limitations & Future Work](https://www.mongodb.com/docs/languages/python/django-mongodb/current/limitations-upcoming/)
3+
## Documentation
84

9-
The documentation in the "docs" directory is online at
5+
Documentation written in the style of MongoDB's documentation is available at
6+
https://www.mongodb.com/docs/languages/python/django-mongodb/current/.
7+
8+
Documentation written in the style of Django's documentation is available at
109
https://django-mongodb-backend.readthedocs.io/en/latest/.
1110

12-
## Install
11+
## Quick Start
12+
13+
### Install
1314

1415
Use the version of `django-mongodb-backend` that corresponds to your version of
1516
Django. For example, to get the latest compatible release for Django 5.2.x:
17+
1618
```bash
1719
pip install django-mongodb-backend==5.2.*
1820
```
1921

20-
## Quickstart
21-
22-
### Start project
22+
### Create a project
2323

2424
From your shell, run the following command to create a new Django project
25-
called `example` using our custom template. Make sure the zipfile referenced
26-
at the end of the template link corresponds to your version of Django.
25+
called `example` using our project template. Make sure the end of the template
26+
URL corresponds to your version of Django (e.g. `5.2.x.zip` for any Django
27+
5.2.x version).
2728

28-
You can check what version of Django you're using with:
2929
```bash
30-
django-admin --version
30+
django-admin startproject example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.2.x.zip
3131
```
3232

33-
The snippet below specifies `5.2.x.zip` at the end of
34-
the template url to get the template for any Django version matching 5.2:
33+
You can check what version of Django you're using with:
3534

3635
```bash
37-
django-admin startproject example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.2.x.zip
36+
django-admin --version
3837
```
3938

40-
4139
### Connect to the database
4240

4341
Navigate to your `example/settings.py` file and replace the `DATABASES`
@@ -54,49 +52,33 @@ DATABASES = {
5452
```
5553

5654
### Run the server
57-
To verify that you installed Django MongoDB Backend and correctly configured your project, run the following command from your project root:
55+
56+
To verify that you correctly configured your project, run the following command
57+
from your project root:
58+
5859
```bash
5960
python manage.py runserver
6061
```
61-
Then, visit http://127.0.0.1:8000/. This page displays a "Congratulations!" message and an image of a rocket.
62-
63-
64-
## Capabilities of Django MongoDB Backend
6562

66-
- **Model MongoDB Documents Through Django’s ORM**
63+
Then, visit http://127.0.0.1:8000/. This page displays a "Congratulations!"
64+
message and an image of a rocket.
6765

68-
- Store Django model instances as MongoDB documents.
69-
- Maps Django's built-in fields to MongoDB data types.
70-
- Provides custom fields for arrays (`ArrayField`) and embedded documents (`EmbeddedModelField`).
71-
- Supports core migration functionalities.
72-
- **Index Management**
73-
- Create single, compound, partial, and unique indexes using Django Indexes.
74-
- **Querying Data**
75-
- Supports most of the Django QuerySet API.
76-
- Supports relational field usage and executes `JOIN` operations with MQL.
77-
- A custom `QuerySet.raw_aggregate` method exposes MongoDB-specific operations like Vector Search, Atlas Search, and GeoSpatial querying to yield Django QuerySet results.
78-
- **Administrator Dashboard & Authentication**
79-
- Manage your data in Django’s admin site.
80-
- Fully integrated with Django's authentication framework.
81-
- Supports native user management features like creating users and session management.
66+
## Getting Help
8267

68+
You can ask usage questions on the [MongoDB Community Forums](https://www.mongodb.com/community/forums/tag/python).
8369

84-
### Issues & Help
70+
## Reporting Bugs and Requesting Features
8571

86-
We're glad to have such a vibrant community of users of Django MongoDB Backend.
87-
You can ask questions and request features through the
88-
[MongoDB Community Forums](https://www.mongodb.com/community/forums/tag/python).
89-
90-
91-
#### Bugs / Feature Requests
92-
To report a bug or to request a new feature in Django MongoDB Backend, please open an issue in JIRA, our issue-management tool, using the following steps:
72+
To report a bug or request a new feature in Django MongoDB Backend, please open
73+
an issue in JIRA:
9374

9475
1. [Create a JIRA account.](https://jira.mongodb.org/)
95-
9676
2. Navigate to the [Python Integrations project](https://jira.mongodb.org/projects/INTPYTHON/).
77+
3. Click **Create Issue**. Please provide as much information as possible about
78+
the issue and the steps to reproduce it.
9779

98-
3. Click **Create Issue**. Please provide as much information as possible about the issue and the steps to reproduce it.
99-
100-
Bug reports in JIRA for the Django MongoDB Backend project can be viewed by everyone.
80+
Bug reports for the Django MongoDB Backend project can be viewed by everyone.
10181

102-
If you identify a security vulnerability in the driver or in any other MongoDB project, please report it according to the instructions found in [Create a Vulnerability Report](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/).
82+
If you identify a security vulnerability in this project or in any other
83+
MongoDB project, please report it according to the instructions found at
84+
[Create a Vulnerability Report](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/).

0 commit comments

Comments
 (0)