Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
forefy committed Feb 11, 2024
1 parent 2989176 commit 6147b3d
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ eburger -h
## How to run

### Simple examples
Simplest:
Simplest
```bash
cd MyProject/
eburger
Expand All @@ -77,18 +77,32 @@ eburger -f MyProject/ -o sarif

<br>

Markdown output
Markdown output (running from the project's directory)
```bash
eburger -f MyProject/ -o markdown
eburger -o markdown
```

<br>

Focused scan of a single file and it's dependencies:
Focused scan of a single file and its dependencies
```bash
eburger -f ../ProjectToScan/src/SomeContract.sol
```

<br>

Only print nsloc count
```bash
eburger -f MyProject/ --nsloc
```

<br>

Run custom YAML templates
```bash
eburger -t MyCustomYAMLs/ -f MyProject/
```

### Advanced usage
Refer to the [Wiki](https://github.com/forefy/eburger/wiki/Advanced-usage).

Expand Down

0 comments on commit 6147b3d

Please sign in to comment.