admin: update docs and CI for v6 release

This commit is contained in:
Richard Moore 2023-02-02 21:28:26 -05:00
parent 5c29a8d1bc
commit 0e8a34805f
4 changed files with 28 additions and 45 deletions

@ -3,7 +3,7 @@ name: CI Tests
on:
push:
branches:
- v6
- main
jobs:

7
CHANGELOG.md Normal file

@ -0,0 +1,7 @@
Changelog
=========
ethers/v6.0.0 (2023-02-02 21:19)
--------------------------------
- Initial v6 release.

@ -1,30 +1,11 @@
The Ethers Project
==================
```
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! :)
```
[![npm (tag)](https://img.shields.io/npm/v/ethers)](https://www.npmjs.com/package/ethers)
[![CI Tests](https://github.com/ethers-io/ethers.js/actions/workflows/test-ci.yml/badge.svg?branch=v6-beta-exports)](https://github.com/ethers-io/ethers.js/actions/workflows/test-ci.yml)
[![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/ethers-io/ethers.js/badge)](https://www.gitpoap.io/gh/ethers-io/ethers.js)
![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/ethers/beta-exports)
[![CI Tests](https://github.com/ethers-io/ethers.js/actions/workflows/test-ci.yml/badge.svg?branch=main)](https://github.com/ethers-io/ethers.js/actions/workflows/test-ci.yml)
![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/ethers/main)
![npm (downloads)](https://img.shields.io/npm/dm/ethers)
[![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/ethers-io/ethers.js/badge)](https://www.gitpoap.io/gh/ethers-io/ethers.js)
[![Twitter Follow](https://img.shields.io/twitter/follow/ricmoo?style=social)](https://twitter.com/ricmoo)
-----
@ -57,10 +38,11 @@ For the latest news and advisories, please follow the
non-marketing, important information only) as well as watch this GitHub project.
For the latest changes, see the
[CHANGELOG](https://github.com/ethers-io/ethers.js/blob/master/CHANGELOG.md).
[CHANGELOG](https://github.com/ethers-io/ethers.js/blob/main/CHANGELOG.md).
**Summaries**
- [September 2022](https://blog.ricmoo.com/highlights-ethers-js-september-2022-d7bda0fc37ed)
- [June 2022](https://blog.ricmoo.com/highlights-ethers-js-june-2022-f5328932e35d)
- [March 2022](https://blog.ricmoo.com/highlights-ethers-js-march-2022-f511fe1e88a1)
- [December 2021](https://blog.ricmoo.com/highlights-ethers-js-december-2021-dc1adb779d1a)
@ -77,7 +59,7 @@ Installing
**NodeJS**
```
/home/ricmoo/some_project> npm install ethers@beta-exports
/home/ricmoo/some_project> npm install ethers
```
**Browser (ESM)**
@ -98,8 +80,8 @@ Documentation
Browse the [documentation](https://docs.ethers.io) online:
- [Getting Started](https://docs.ethers.io/v5/getting-started/)
- [Full API Documentation](https://docs.ethers.io/v5/api/)
- [Getting Started](https://docs.ethers.io/v6/getting-started/)
- [Full API Documentation](https://docs.ethers.io/v6/api/)
- [Various Ethereum Articles](https://blog.ricmoo.com/)
@ -127,6 +109,7 @@ the documentation.
A special thanks to these services for providing community resources:
- [Ankr](https://www.ankr.com/)
- [QuickNode](https://www.quicknode.com/)
- [Etherscan](https://etherscan.io/)
- [INFURA](https://infura.io/)
- [Alchemy](https://dashboard.alchemyapi.io/signup?referral=55a35117-028e-4b7c-9e47-e275ad0acc6d)

@ -1,20 +1,4 @@
_section: Documentation (BETA) @<about-home> @nav<Documentation>
**NOTE:** This documentation is for the **beta branch** (i.e. ``v6-beta-exports``), which
is still undergoing minor changes.
To try it out:
_code:
/home/ricmoo> npm install ethers@beta-exports
_null:
Please [report any v6 issues](link-issue) and I will get to them right away.
If you are looking v5 docs, please see the [v5 documentation here](link-docs-v5).
_subsection: What is Ethers?
_section: Documentation @<about-home> @nav<Documentation>
The ethers.js library aims to be a complete and compact library
for interacting with the Ethereum Blockchain and its ecosystem.
@ -24,6 +8,7 @@ wallets (such as [[link-metamask]] and [[link-tally]]) and
other tools and simple scripts that require reading and writing
to the blockchain.
_subsection: About this documentation?
These docs are still under construction, and are being expanded
@ -32,4 +17,12 @@ every day.
Developers new to Ethers shoud be sure to read through the
[[getting-started]] section.
And the [[about-api]] is available for drilling down into more details.
And the [[about-api]] is available for drilling down into more details
about the entire Application Programming Interface.
_subsection: Older Documentation
- [v5 documentation here](link-docs-v5)
- [v4 documentation here](link-docs-v4)
- [v3 documentation here](link-docs-v3)