From 9d0f8dcc77dfae10c25722f43d5f1b1f7c6501ca Mon Sep 17 00:00:00 2001 From: AkiraFukushima Date: Wed, 25 Mar 2020 22:46:01 +0900 Subject: [PATCH] Add readme for migration guide --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 9c3f16a..31bd0f9 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,10 @@ A Mastodon, Pleroma and Misskey API Client library for node.js and browser. It provides REST API and streaming methods. By using this library, you can take Mastodon, Pleroma and Misskey with the same interface. +## !!Migrate v2.x to v3.0.0 +There are some breaking changes, so you can not update megalodon out of the box. +Please refer [migration guide](migration_guide.md) before you update megalodon version. + ## Features - REST API