From 9fd9cd1117d00d2d637cb0140b05cc3a47be685c Mon Sep 17 00:00:00 2001
From: Tom Limoncelli <tal@whatexit.org>
Date: Sat, 4 Apr 2020 06:09:14 -0400
Subject: [PATCH] Link to migration guide

---
 README.md         | 4 ++++
 docs/v1/manual.md | 8 ++++++++
 docs/v2/manual.md | 8 ++++++++
 3 files changed, 20 insertions(+)

diff --git a/README.md b/README.md
index ae9d19b..408668b 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,10 @@ Usage documentation exists for each major version. Don't know what version you'r
 - `v2` - [./docs/v2/manual.md](./docs/v2/manual.md)
 - `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)
 
+Guides for migrating to newer versions:
+
+- `v1-to-v2` - [./docs/migrate-v1-to-v2.md](./docs/migrate-v1-to-v2.md)
+
 ## Installation
 
 Using this package requires a working Go environment. [See the install instructions for Go](http://golang.org/doc/install.html).
diff --git a/docs/v1/manual.md b/docs/v1/manual.md
index 51c5b72..05ea370 100644
--- a/docs/v1/manual.md
+++ b/docs/v1/manual.md
@@ -27,6 +27,7 @@ cli v1 manual
   * [Version Flag](#version-flag)
     + [Customization](#customization-2)
     + [Full API Example](#full-api-example)
+  * [Migrating to V2](#migrating-to-v2)
 
 <!-- tocstop -->
 
@@ -1476,3 +1477,10 @@ func wopAction(c *cli.Context) error {
   return nil
 }
 ```
+
+## Migrating to V2
+
+There are a small set of breaking changes between v1 and v2.
+Converting is relatively straightforward and typically takes less than
+an hour. Specific steps are included in
+[Migration Guide: v1 to v2](../migrate-v1-to-v2.md).
diff --git a/docs/v2/manual.md b/docs/v2/manual.md
index 71f5699..750590c 100644
--- a/docs/v2/manual.md
+++ b/docs/v2/manual.md
@@ -3,6 +3,7 @@ cli v2 manual
 
 <!-- toc -->
 
+- [Migrating From v1](#migrating-from-v1)
 - [Getting Started](#getting-started)
 - [Examples](#examples)
   * [Arguments](#arguments)
@@ -38,6 +39,13 @@ cli v2 manual
 
 <!-- tocstop -->
 
+## Migrating From Older Releases
+
+There are a small set of breaking changes between v1 and v2.
+Converting is relatively straightforward and typically takes less than
+an hour. Specific steps are included in
+[Migration Guide: v1 to v2](../migrate-v1-to-v2.md).
+
 ## Getting Started
 
 One of the philosophies behind cli is that an API should be playful and full of