Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
typo
  • Loading branch information
idocyabra committed Jan 22, 2024
1 parent f04b97c commit 3eb8c1a
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Flask-MongoEngine

[![PyPI version](https://badge.fury.io/py/flask-mongoengine-2.svg)](https://badge.fury.io/py/flask-mongoengine-2)
[![PyPI version](https://badge.fury.io/py/flask-mongoengine-3.svg)](https://badge.fury.io/py/flask-mongoengine-3)
[![CI Tests](https://github.com/idoshr/flask-mongoengine/actions/workflows/tests.yml/badge.svg)](https://github.com/flask/flask-mongoengine/actions/workflows/tests.yml)
[![Documentation Status](https://readthedocs.org/projects/flask-mongoengine/badge/?version=latest)](http://docs.mongoengine.org/projects/flask-mongoengine/en/latest/?badge=latest)
[![Maintainability](https://api.codeclimate.com/v1/badges/6fb8ae00b1008f5f1b20/maintainability)](https://codeclimate.com/github/idoshr/flask-mongoengine/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/6fb8ae00b1008f5f1b20/test_coverage)](https://codeclimate.com/github/MongoEngine/flask-mongoengine/test_coverage)
![PyPI - Downloads](https://img.shields.io/pypi/dm/flask-mongoengine-2)
[![Test Coverage](https://api.codeclimate.com/v1/badges/6fb8ae00b1008f5f1b20/test_coverage)](https://codeclimate.com/github/idoshr/flask-mongoengine/test_coverage)
![PyPI - Downloads](https://img.shields.io/pypi/dm/flask-mongoengine-3)

Flask-MongoEngine is a Flask extension that provides integration with [MongoEngine],
[WtfForms] and [FlaskDebugToolbar].
Expand All @@ -24,7 +24,7 @@ used together.

```bash
# For Flask >= 2.0.0
pip install flask-mongoengine
pip install flask-mongoengine-3
```

We still maintain special case for [Flask] = 1.1.4 support (the latest version in 1.x.x
Expand All @@ -33,7 +33,7 @@ extra option.

```bash
# With Flask 1.1.4 dependencies
pip install flask-mongoengine[legacy]
pip install flask-mongoengine-3[legacy]
```

### Installation with WTFForms and Flask-WTF support
Expand All @@ -43,7 +43,7 @@ will extend project dependencies with [Flask-WTF], [WTFForms] and related packag

```bash
# With Flask-WTF and WTFForms dependencies
pip install flask-mongoengine[wtf]
pip install flask-mongoengine-3[wtf]
```

### Installation with Flask Debug Toolbar support
Expand All @@ -54,14 +54,14 @@ you need to install flask-mongoengine with related support, use:

```bash
# With FlaskDebugToolbar dependencies
pip install flask-mongoengine[toolbar]
pip install flask-mongoengine-3[toolbar]
```

### Installation with all features together

```bash
# With Flask-WTF, WTFForms and FlaskDebugToolbar dependencies
pip install flask-mongoengine[wtf,toolbar]
pip install flask-mongoengine-3[wtf,toolbar]
```

## Flask configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
master_doc = "index"

# General information about the project.
project = "Flask-MongoEngine-2"
project = "Flask-MongoEngine-3"
copyright = "2010-2024, Streetlife and others"

# The version info for the project you're documenting, acts as replacement for
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "flask-mongoengine-2"
name = "flask-mongoengine-3"
description = "Flask extension that provides integration with MongoEngine and WTF model forms."
readme = "README.md"
requires-python = ">=3.8"
Expand Down

0 comments on commit 3eb8c1a

Please sign in to comment.