Skip to content

Prepare Solidstate release #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ItsNickBarry wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Prepare Solidstate release #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6fc070c
prepare readme and package.json for solidstate release
ItsNickBarry Jan 12, 2023
744e3af
Merge branch 'master' into solidstate
ItsNickBarry Apr 26, 2025
f162a5e
Merge branch 'master' into solidstate
ItsNickBarry May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,22 @@

Generate a static documentation site from NatSpec comments automatically on compilation with Hardhat.

> Versions of this plugin prior to `2.0.0` were released as `hardhat-docgen`, outside of the `@solidstate` namespace.

## Installation

```bash
npm install --save-dev hardhat-docgen
npm install --save-dev @solidstate/hardhat-docgen
# or
yarn add --dev hardhat-docgen
yarn add --dev @solidstate/hardhat-docgen
```

## Usage

Load plugin in Hardhat config:

```javascript
require('hardhat-docgen');
require('@solidstate/hardhat-docgen');
```

Add configuration under the `docgen` key:
Expand Down
9 changes: 6 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hardhat-docgen",
"version": "1.3.0",
"name": "@solidstate/hardhat-docgen",
"version": "2.0.0",
"description": "Generate NatSpec documentation automatically on compilation",
"keywords": [
"hardhat",
Expand All @@ -16,7 +16,7 @@
"blockchain",
"wow"
],
"repository": "https://github.com/ItsNickBarry/hardhat-docgen",
"repository": "github:solidstate-network/hardhat-docgen",
"license": "MIT",
"author": "Nick Barry",
"main": "index.js",
Expand Down Expand Up @@ -50,5 +50,8 @@
},
"engines": {
"node": ">=14.14.0"
},
"publishConfig": {
"access": "public"
}
}