Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: add a 'When should I migrate' section #19

Merged
merged 1 commit into from Jan 23, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
Expand Up @@ -2,6 +2,20 @@

These are migrations for the filesystem repository of [ipfs](https://github.com/ipfs/ipfs) clients. This tool is written in Go, and developed alongside [go-ipfs](https://github.com/ipfs/go-ipfs), but it should work with any repo conforming to the [fs-repo specs](https://github.com/ipfs/specs/tree/master/repo/fs-repo).

## When should I migrate

When you want to upgrade go-ipfs to a new version, you may need to
migrate.

Here is the table showing which repo version corresponds to which
go-ipfs version:

ipfs repo version | go-ipfs versions
----------------- | ----------------
1 | 0.0.0 - 0.2.3
2 | 0.3.0 - 0.3.11
3 | 0.4.0 - current

## How to Run Migrations

Please see the [migration run guide here](run.md).
Expand Down