Skip to content

Commit 61b86e2

Browse files
committed
Cleanup README (wrap lines, clarify docs, remove list of features)
1 parent b94f0fc commit 61b86e2

File tree

1 file changed

+18
-37
lines changed

1 file changed

+18
-37
lines changed

README.md

Lines changed: 18 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
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

1211
## Install
@@ -16,7 +15,6 @@ Django. For example, to get the latest compatible release for Django 5.2.x:
1615
```bash
1716
pip install django-mongodb-backend==5.2.*
1817
```
19-
2018
## Quickstart
2119

2220
### Start project
@@ -37,7 +35,6 @@ the template url to get the template for any Django version matching 5.2:
3735
django-admin startproject example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.2.x.zip
3836
```
3937

40-
4138
### Connect to the database
4239

4340
Navigate to your `example/settings.py` file and replace the `DATABASES`
@@ -54,49 +51,33 @@ DATABASES = {
5451
```
5552

5653
### 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:
54+
To verify that you installed Django MongoDB Backend and correctly configured
55+
your project, run the following command from your project root:
5856
```bash
5957
python manage.py runserver
6058
```
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
65-
66-
- **Model MongoDB Documents Through Django’s ORM**
67-
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.
82-
59+
Then, visit http://127.0.0.1:8000/. This page displays a "Congratulations!"
60+
message and an image of a rocket.
8361

8462
### Issues & Help
8563

86-
We're glad to have such a vibrant community of users of Django MongoDB Backend.
8764
You can ask questions and request features through the
8865
[MongoDB Community Forums](https://www.mongodb.com/community/forums/tag/python).
8966

90-
9167
#### 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:
68+
To report a bug or to request a new feature in Django MongoDB Backend, please
69+
open an issue in JIRA, our issue-management tool, using the following steps:
9370

9471
1. [Create a JIRA account.](https://jira.mongodb.org/)
9572

9673
2. Navigate to the [Python Integrations project](https://jira.mongodb.org/projects/INTPYTHON/).
9774

98-
3. Click **Create Issue**. Please provide as much information as possible about the issue and the steps to reproduce it.
75+
3. Click **Create Issue**. Please provide as much information as possible about
76+
the issue and the steps to reproduce it.
9977

100-
Bug reports in JIRA for the Django MongoDB Backend project can be viewed by everyone.
78+
Bug reports in JIRA for the Django MongoDB Backend project can be viewed by
79+
everyone.
10180

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/).
81+
If you identify a security vulnerability in the driver or in any other MongoDB
82+
project, please report it according to the instructions found in
83+
[Create a Vulnerability Report](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/).

0 commit comments

Comments
 (0)