add a section on why use this extension to the docs (fixes #101)

miguelgrinberg · May 19, 2019 · 5467b29 · 5467b29
1 parent 65fbd97
commit 5467b29
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ Flask-Migrate
 
 [![Build Status](https://travis-ci.org/miguelgrinberg/Flask-Migrate.png?branch=master)](https://travis-ci.org/miguelgrinberg/Flask-Migrate)
 
-Flask-Migrate is an extension that handles SQLAlchemy database migrations for Flask applications using Alembic. The database operations are provided as command line arguments for Flask-Script.
+Flask-Migrate is an extension that handles SQLAlchemy database migrations for Flask applications using Alembic. The database operations are provided as command-line arguments under the `flask db` command.
 
 Installation
 ------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,6 +8,11 @@ Welcome to Flask-Migrate's documentation!
 
 **Flask-Migrate** is an extension that handles SQLAlchemy database migrations for Flask applications using Alembic. The database operations are made available through the Flask command-line interface or through the Flask-Script extension.
 
+Why Use Flask-Migrate vs. Alembic Directly?
+--------------------------------------
+
+Flask-Migrate is an extension that configures Alembic in the proper way to work with your Flask and Flask-SQLAlchemy application. In terms of the actual database migrations, everything is handled by Alembic so you get exactly the same functionality.
+
 Installation
 ------------