From 280abc2c9989929ac5b4c619c2977f8d1d97927d Mon Sep 17 00:00:00 2001
From: Juan Pablo Ramirez <pabloelcolombiano@gmail.com>
Date: Mon, 26 Jul 2021 23:50:44 +0200
Subject: [PATCH] #20 Documentation update

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index ce5ec62..102261d 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,17 @@ In config/app.php
 
 You can set `migrations` simply to `true` if you which to use the default migration settings. 
 
+### Migrations status
+
+Information on a connection's migration status will be obtained as follows:
+```
+$migrator = Migrator::migrate();
+$connectionsWithModifiedStatus = $migrator->getConnectionsWithModifiedStatus();
+```
+
+the method `getConnectionsWithModifiedStatus` returning a list of the connections with down
+migrations prior to running the migrations.
+
 ### What happens if I switch branches?
 
 If you ever switched to a branch with nonexistent up migrations, you've moved to a branch in a past state.