Merge pull request #7139 from NomicFoundation/hardhat-3-readmes

Update readmes

Author: kanej

README.md

@@ -1,53 +1,31 @@
-![](https://user-images.githubusercontent.com/176499/96893278-ebc67580-1460-11eb-9530-d5df3a3d65d0.png) [![NPM Package](https://img.shields.io/npm/v/hardhat.svg?style=flat-square)](https://www.npmjs.org/package/hardhat) [![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/NomicFoundation/hardhat/badge)](https://www.gitpoap.io/gh/NomicFoundation/hardhat)
+![](https://user-images.githubusercontent.com/176499/96893278-ebc67580-1460-11eb-9530-d5df3a3d65d0.png)
 
----
-
-Hardhat is an Ethereum development environment for professionals. It facilitates performing frequent tasks, such as running tests, automatically checking code for mistakes or interacting with a smart contract. Check out the [plugin list](https://hardhat.org/plugins/) to use it with your existing tools.
+Hardhat is an Ethereum development environment for professionals. It facilitates performing frequent tasks, such as running tests, automatically checking code for mistakes or interacting with smart contracts. 
 
 Built by the [Nomic Foundation](https://nomic.foundation/) for the Ethereum community.
 
-Join our [Hardhat Support Discord server](https://hardhat.org/discord) to stay up to date on new releases, plugins and tutorials.
-
 ---
 
-> 💡 **The Nomic Foundation is hiring! Check [our open positions](https://www.nomic.foundation/jobs?utm_source=myALpQnzlM).**
+> 💡 This is the README for Hardhat 3, the new major version of Hardhat. For the previous version (v2), see [this branch](https://github.com/NomicFoundation/hardhat/tree/v2) instead.
 
 ---
 
-## Installation
+## Getting started
 
-To install Hardhat, go to an empty folder, initialize an `npm` project (i.e. `npm init`), and run
+To install Hardhat and initialize a new project, run the following command in an empty directory:
 
-```
-npm install --save-dev hardhat
+```bash
+npx hardhat --init
 ```
 
-Once it's installed, just run this command and follow its instructions:
-
-```
-npx hardhat init
-```
+This will take you through an interactive setup process to get started.
 
-## Documentation
+## Learn more
 
-On [Hardhat's website](https://hardhat.org) you will find:
-
-- [Guides to get started](https://hardhat.org/getting-started/)
-- [Hardhat Network](https://hardhat.org/hardhat-network/)
-- [Plugin list](https://hardhat.org/plugins/)
+To learn more about Hardhat, check out the [documentation](https://hardhat.org/docs/).
 
 ## Contributing
 
 Contributions are always welcome! Feel free to open any issue or send a pull request.
 
-Go to [CONTRIBUTING.md](https://github.com/NomicFoundation/hardhat/blob/main/CONTRIBUTING.md) to learn about how to set up Hardhat's development environment.
-
-## Feedback, help and news
-
-[Hardhat Support Discord server](https://hardhat.org/discord): for questions and feedback.
-
-[Follow Hardhat on Twitter.](https://twitter.com/HardhatHQ)
-
-## Happy building!
-
-👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️
+Go to [CONTRIBUTING.md](https://github.com/NomicFoundation/hardhat/blob/main/CONTRIBUTING.md) to learn about how to set up Hardhat's development environment.

v-next/hardhat-errors/README.md

@@ -1,4 +1,6 @@
-# Hardhat errors
+# hardhat-errors
+
+> ⚠️ This package is an internal Hardhat component and it's not meant to be used directly.
 
 This packages has the definition of the error classes used by Hardhat, and the list of possible errors.
 

v-next/hardhat-ethers-chai-matchers/README.md

@@ -1,52 +1,41 @@
-# Hardhat Ethers Chai Matchers plugin
+# hardhat-ethers-chai-matchers
 
 This plugin adds Ethereum-specific matchers to the [Chai](https://chaijs.com/) assertion library that integrate with [ethers.js](https://ethers.org/), making your smart contract tests easy to write and read.
 
 ## Installation
 
+> This plugin is part of the [Ethers+Mocha Hardhat Toolbox](/v-next/hardhat-toolbox-mocha-ethers/). If you are using that toolbox, there's nothing else you need to do.
+
 To install this plugin, run the following command:
 
 ```bash
-npm install --save-dev @nomicfoundation/hardhat-ethers-chai-matchers@next
+npm install --save-dev @nomicfoundation/hardhat-ethers-chai-matchers
 ```
 
-and add the following statements to your `hardhat.config.ts` file:
-
-```typescript
-// ...
-import ethersChaiMatchersPlugin from "@nomicfoundation/hardhat-ethers-chai-matchers";
+In your `hardhat.config.ts` file, import the plugin and add it to the `plugins` array:
 
-// ...
+```ts
+import hardhatEthersChaiMatchers from "@nomicfoundation/hardhat-ethers-chai-matchers";
 
 export default {
-  // ...
-  plugins: [
-    // ...
-    ethersChaiMatchersPlugin,
-  ],
-
-  // ...
+  plugins: [hardhatEthersChaiMatchers],
 };
 ```
 
 ## Usage
 
 You don't need to do anything else to use this plugin. Whenever you run your tests with Hardhat, it will automatically add the matchers.
 
-Here is an example of using the `changeEtherBalances` matcher:
+Here is an example of using the `emit` matcher:
 
 ```ts
 import { expect } from "chai";
 
-// ...
-// ...
-
-const amount = ethers.utils.parseEther("1");
+it("some test", async function () {
+  const contract = await ethers.deployContract("SomeContract");
 
-await expect(() =>
-  sender.sendTransaction({
-    to: contract,
-    value: AMOUNT,
-  }),
-).to.changeEtherBalances(provider, [sender, contract], [-AMOUNT, AMOUNT]);
+  await expect(contract.someFunction())
+    .to.emit(contract, "SomeEvent")
+    .withArgs("0x...", 3);
+});
 ```