Skip to content

Commit

Permalink
Added 'npm package' badge
Browse files Browse the repository at this point in the history
  • Loading branch information
shanshi committed Feb 10, 2021
1 parent 70541ef commit 5edcedd
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Solidoc: Documentation Generator for Solidity

[![npm version](https://badge.fury.io/js/%40thinkanddev%2Fsolidoc.svg)](https://www.npmjs.com/package/@thinkanddev/solidoc)

This command-line utility creates markdown-based documentation for your Solidity project(s) for the following platforms:

* Ethereum
Expand Down Expand Up @@ -43,7 +45,7 @@ Using a [configuration file](#configuration-file) is recommended (mostly if you

**How to Use Solidoc?**

On your project root, run the following command.
On your project root, run the following command:

```npm
solidoc ./ ./docs true
Expand All @@ -59,19 +61,19 @@ This will generate documentation to the `docs` directory.
}
```

and run
and run:

```npm
npm run docgen
```

**Note**

Do not use recompilation (third argument) if you are using this on a non truffle project.
Do not use recompilation (third argument) if you are using this on a non Truffle project.

## Configuration File

Alternatively, you can create `solidoc.json` configuration file in your project root.
Alternatively, you can create `solidoc.json` configuration file in your project root:

```json
{
Expand Down

0 comments on commit 5edcedd

Please sign in to comment.