Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
robschleusner committed Nov 21, 2023
1 parent 5d46e89 commit 66e95ec
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# hardhat-quai-plugin
# quai-hardhat-plugin

A hardhat plugin to handle solidityX compiler ( for beginning )
A hardhat plugin to handle SolidityX compiler

[Hardhat](https://hardhat.org) plugin example.

## Installation

<_A step-by-step guide on how to install the plugin_>
_A step-by-step guide on how to install the plugin_

```bash
npm install quai-hardhat-plugin
Expand All @@ -31,6 +31,7 @@ This plugin extends the `HardhatUserConfig`'s `ProjectPathsUserConfig` object wi

This is an example of how to set it:

Add the path in your `hardhat.config.js`:
```js
module.exports = {
solidityx: {
Expand All @@ -39,6 +40,15 @@ module.exports = {
};
```

Or if you are using TypeScript, in your `hardhat.config.ts`:
```ts
const config: HardhatUserConfig = {
solidityx: {
compilerPath: "PATH_TO_SOLC_COMPILER",
},
}
```

### Acknowledgements

Special thanks to [Saiaman](https://github.com/saiaman) for creating this plugin.

0 comments on commit 66e95ec

Please sign in to comment.