From ec2377287eacfe51b75d07ae962d1c6e0359843a Mon Sep 17 00:00:00 2001
From: cupcakearmy <hi@nicco.io>
Date: Sat, 17 Apr 2021 17:04:43 +0200
Subject: [PATCH] docs

---
 ROADMAP.md               | 11 -----------
 docs/markdown/_toc.md    |  2 +-
 docs/markdown/index.md   |  4 +++-
 docs/markdown/upgrade.md | 26 ++++++++++++++++++++++++++
 4 files changed, 30 insertions(+), 13 deletions(-)
 delete mode 100644 ROADMAP.md
 create mode 100644 docs/markdown/upgrade.md

diff --git a/ROADMAP.md b/ROADMAP.md
deleted file mode 100644
index bdafe67..0000000
--- a/ROADMAP.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# Roadmap
-
-## Todo
-
-- install script
-
-## Packages
-
-- https://github.com/fatih/color
-- https://github.com/manifoldco/promptui
-- https://github.com/AlecAivazis/survey
diff --git a/docs/markdown/_toc.md b/docs/markdown/_toc.md
index 199003f..f041ce5 100644
--- a/docs/markdown/_toc.md
+++ b/docs/markdown/_toc.md
@@ -1,7 +1,7 @@
 [Home](/)
 [Quick Start](/quick)
-<!-- [Installation](/installation) -->
 [Configuration](/config)
+[Upgrade](/upgrade)
 
 > :Collapse label=Locations
 >
diff --git a/docs/markdown/index.md b/docs/markdown/index.md
index 4b7f3f7..fd43973 100644
--- a/docs/markdown/index.md
+++ b/docs/markdown/index.md
@@ -1,9 +1,11 @@
-# `autorestic`
+# autorestic
 
 High backup level CLI utility for [restic](https://restic.net/).
 
 Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂
 
+> If you are coming from `0.x` see the [upgrade guide](/upgrade).
+
 ## 🌈 Features
 
 - YAML config files, no CLI
diff --git a/docs/markdown/upgrade.md b/docs/markdown/upgrade.md
new file mode 100644
index 0000000..202575d
--- /dev/null
+++ b/docs/markdown/upgrade.md
@@ -0,0 +1,26 @@
+# Update
+
+## From `0.x` to `1.0`
+
+Most of the config file is remained compatible, however to clean up the backends custom environment variables were moved from the root object to an `env` object.
+
+```yaml
+# Before
+remote:
+    type: b2
+    path: bucket:path/to/backup
+    key: some random encryption key
+    B2_ACCOUNT_ID: id
+    B2_ACCOUNT_KEY: key
+
+# After
+remote:
+    type: b2
+    path: bucket:path/to/backup
+    key: some random encryption key
+    env:
+      B2_ACCOUNT_ID: id
+      B2_ACCOUNT_KEY: key
+```
+
+> :ToCPrevNext