Skip to content

Commit 3320c77

Browse files
committed
add notes about 0.6 rewrite
1 parent 3d98c8b commit 3320c77

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## 0.6.0
4+
5+
This version is a complete rewrite and redesign of the library that is currently in beta.
6+
37
## 0.5.16
48

59
- Change handling of circular dependencies to an incomplete but correct approach, fixing a potential issue with bad caching.

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44

55
The output is fully configurable through Handlebars templates, but the default templates should do a good job of displaying all of the information in the source code in Markdown format. The generated Markdown files can be used with a static site generator such as Vuepress, MkDocs, Jekyll (GitHub Pages), etc., in order to publish a documentation website.
66

7+
This is a newer version of the tool that has been rewritten and redesigned. Some more work is pending to ease the transition from the previous version and to help with with usage and configuration.
8+
79
## Usage
810

9-
Install `solidity-docgen@next` from npm.
11+
Install `solidity-docgen` from npm.
1012

1113
### Hardhat
1214

0 commit comments

Comments
 (0)