From a5f4ba4efdec459776b9e299f60572e939ab9bd8 Mon Sep 17 00:00:00 2001 From: Austin Roberts Date: Mon, 28 Jun 2021 13:02:05 -0500 Subject: [PATCH] Add stability warnings --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 398842827..6ddb6431c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,14 @@ PluGeth is a fork of the [Go Ethereum Client](https://github.com/ethereum/go-eth Geth's capabilities in a number of different ways using plugins, rather than having to create additional, new forks of Geth. +## WARNING: UNSTABLE API + +Right now PluGeth is in early development. We are still settling on some of the +plugin APIs, and are not yet making official releases. From an operational +perspective, PluGeth should be as stable as upstream Geth, less whatever +instability is added by plugins you might run. But if you plan to run PluGeth +today, be aware that future updates will likely break your plugins. + ## System Requirements System requirements will vary depending on which network you are connecting to.