summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index efe614f..af587fd 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,20 @@
[![Docs](https://docs.rs/mastodon-async/badge.svg)](https://docs.rs/mastodon-async)
[![MIT/APACHE-2.0](https://img.shields.io/crates/l/mastodon-async.svg)](https://crates.io/crates/mastodon-async)
+# V2 WIP
+
+This is a branch tracking version 2 of this library, which will bring the
+library current with all documented routes and entities, and come with some
+breaking changes. Once the process of "combing" the documentation is complete,
+v2 RCs and then a release will be cut from this branch, which will then be
+renamed `main`.
+
+V1 is still being used in some capacity by some projects, but new features are
+not being developed for it. Please develop new features targeting this branch,
+and review the work already done starting at issue #54.
+
+---
+
[Documentation](https://docs.rs/mastodon-async/)
A type-safe, async wrapper around the client [API](https://docs.joinmastodon.org/client/intro/)