Link to migration guide

This commit is contained in:
Tom Limoncelli 2020-04-04 06:09:14 -04:00
parent 200fa41ab3
commit 9fd9cd1117
3 changed files with 20 additions and 0 deletions

View File

@ -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) - `v2` - [./docs/v2/manual.md](./docs/v2/manual.md)
- `v1` - [./docs/v1/manual.md](./docs/v1/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 ## Installation
Using this package requires a working Go environment. [See the install instructions for Go](http://golang.org/doc/install.html). Using this package requires a working Go environment. [See the install instructions for Go](http://golang.org/doc/install.html).

View File

@ -27,6 +27,7 @@ cli v1 manual
* [Version Flag](#version-flag) * [Version Flag](#version-flag)
+ [Customization](#customization-2) + [Customization](#customization-2)
+ [Full API Example](#full-api-example) + [Full API Example](#full-api-example)
* [Migrating to V2](#migrating-to-v2)
<!-- tocstop --> <!-- tocstop -->
@ -1476,3 +1477,10 @@ func wopAction(c *cli.Context) error {
return nil 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).

View File

@ -3,6 +3,7 @@ cli v2 manual
<!-- toc --> <!-- toc -->
- [Migrating From v1](#migrating-from-v1)
- [Getting Started](#getting-started) - [Getting Started](#getting-started)
- [Examples](#examples) - [Examples](#examples)
* [Arguments](#arguments) * [Arguments](#arguments)
@ -38,6 +39,13 @@ cli v2 manual
<!-- tocstop --> <!-- 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 ## Getting Started
One of the philosophies behind cli is that an API should be playful and full of One of the philosophies behind cli is that an API should be playful and full of