From 92c217fb2838f59e2958aa4360f359e4e5bfc422 Mon Sep 17 00:00:00 2001 From: Richard Moore Date: Mon, 5 Sep 2022 16:41:13 -0400 Subject: [PATCH] Updated the readme for v6. --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5b0ac366c..30be2cbd1 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,26 @@ The Ethers Project ================== ``` -This branch (i.e. v6-beta-exports) can be install via npm using -"npm install ethers@beta-exports" and is highly experimental. +This branch (i.e. v6-beta-exports) is still experimental and a +playground for new ideas for the upcoming v6 release. Please +don't use it in production yet. + +To install: + npm install ethers@beta-exports + +Please try it out and report any bugs you find using the v6-beta +template in the GitHub issues. + +Documentation is coming, but will still take a bit of time. + +In general, please be a patient as there is lots to do. + + +Thanks! :) ``` +----- + A complete, compact and simple library for Ethereum and ilk, written in [TypeScript](https://www.typescriptlang.org). @@ -59,9 +75,11 @@ Installing **Browser (ESM)** +The bundled library is available in the `./dist/` folder in this repo. + ``` ``` @@ -69,6 +87,8 @@ Installing Documentation ------------- +**Note: The v6 docs are not available yet** + Browse the [documentation](https://docs.ethers.io) online: - [Getting Started](https://docs.ethers.io/v5/getting-started/)