Updated the readme for v6.

This commit is contained in:
Richard Moore 2022-09-05 16:41:13 -04:00
parent 924f59e5f5
commit 92c217fb28

@ -2,10 +2,26 @@ The Ethers Project
================== ==================
``` ```
This branch (i.e. v6-beta-exports) can be install via npm using This branch (i.e. v6-beta-exports) is still experimental and a
"npm install ethers@beta-exports" and is highly experimental. 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 A complete, compact and simple library for Ethereum and ilk, written
in [TypeScript](https://www.typescriptlang.org). in [TypeScript](https://www.typescriptlang.org).
@ -59,9 +75,11 @@ Installing
**Browser (ESM)** **Browser (ESM)**
The bundled library is available in the `./dist/` folder in this repo.
``` ```
<script type="module"> <script type="module">
import { ethers } from "https://cdn.ethers.io/lib/ethers-5.6.esm.min.js"; import { ethers } from "./dist/ethers.min.js";
</script> </script>
``` ```
@ -69,6 +87,8 @@ Installing
Documentation Documentation
------------- -------------
**Note: The v6 docs are not available yet**
Browse the [documentation](https://docs.ethers.io) online: Browse the [documentation](https://docs.ethers.io) online:
- [Getting Started](https://docs.ethers.io/v5/getting-started/) - [Getting Started](https://docs.ethers.io/v5/getting-started/)