From 99bd878c98e971edc95fb3be0dca79f02ee659f2 Mon Sep 17 00:00:00 2001
From: Roland <roland@learningselfreliance.com>
Date: Tue, 3 May 2022 11:00:09 -0600
Subject: [PATCH] Adding upgrade instructions to Readme.

---
 README.md  | 18 +++++++++++++++---
 UPGRADE.md | 16 ++++++++++++++++
 2 files changed, 31 insertions(+), 3 deletions(-)
 create mode 100644 UPGRADE.md

diff --git a/README.md b/README.md
index fd45c969..f7fc751a 100644
--- a/README.md
+++ b/README.md
@@ -36,8 +36,20 @@ network so that any person with a laptop/tablet/phone can connect and use the da
 - [ ] Podcast player & downloader
 
 # Demo
+
 <a href="https://www.youtube.com/watch?v=g0Do_mlQcBU"> ![YouTube Demo Video](https://raw.githubusercontent.com/lrnselfreliance/wrolpi/master/demo_link.jpg)</a>
 
+
+Table of Contents
+=================
+
+* [Try WROLPi](#try-wrolpi)
+* [Debian 11 Install](#debian-11-install)
+* [Raspberry Pi Install](#raspberrypi-install)
+* [Charter](#charter)
+* [Upgrading WROLPi](UPGRADE.md)
+* [Join](#charter)
+
 # Try WROLPi!
 
 You can try out WROLPi by running the docker containers.
@@ -49,10 +61,10 @@ You can try out WROLPi by running the docker containers.
 3. Change directory into the code base
     * `cd wrolpi`
 4. Build the containers
-   * `docker-compose build --parallel`
+    * `docker-compose build --parallel`
 5. Create volumes
-   * `docker volume create --name=openstreetmap-data`
-   * `docker volume create --name=openstreetmap-rendered-tiles`
+    * `docker volume create --name=openstreetmap-data`
+    * `docker volume create --name=openstreetmap-rendered-tiles`
 6. Start the database.
     * `docker-compose up -d db`
 7. Initialize the database
diff --git a/UPGRADE.md b/UPGRADE.md
new file mode 100644
index 00000000..62110387
--- /dev/null
+++ b/UPGRADE.md
@@ -0,0 +1,16 @@
+# Upgrading WROLPi
+
+## Upgrading Docker containers
+
+1. Pull the latest master
+    * `git pull origin master --ff`
+2. Stop docker containers
+    * `docker-compose stop`
+3. Build all docker containers
+    * `docker-compose build --parallel`
+4. Turn on the database
+    * `docker-compose up -d db`
+5. Upgrade the database
+    * `docker-compose run --rm api db upgrade`
+6. Start all docker containers
+    * `docker-compose up -d`