Skip to content

Commit

Permalink
new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ehne committed Jul 3, 2020
1 parent 2e1ef85 commit 3abb1b0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ you may also need to [install graphvis](https://graphviz.org/download/) to be ab

## CLI Usage
```
Usage: erdot [OPTIONS]
Usage: erdot INPUTFILE [OPTIONS]
Options:
-i, --inputFile TEXT The input ERDJSON file (.json) [required]
-o, --outputFile TEXT The graphvis dot file to write to (.dot) (default: ERDotOutput.dot)
INPUTFILE TEXT The input ERDJSON file (.erd.json) [required]
-o, --outputFile TEXT The graphvis dot file to write to (.dot) [not required]
--help Show this message and exit.
```

Note that after generating the .dot file, you will still need to output it to your desired format using graphviz. An example of how to do this:

```bash
erdot -i inputFile.erd.json
erdot example.erd.json

dot ERDotOutput.dot -Tpng -o imageFile.png
dot example.dot -Tpng -o imageFile.png
```

(You could also copy and paste the contents of the .dot file into an [online graphviz viewer](https://edotor.net))
Expand Down

0 comments on commit 3abb1b0

Please sign in to comment.