Skip to content

Commit

Permalink
update readme.md commands
Browse files Browse the repository at this point in the history
  • Loading branch information
bykof committed Dec 16, 2024
1 parent 1c9afe4 commit 97239d4
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ Please consider that `$GOPATH/bin` should be on our `$PATH`.
## Usage

```bash
Generate plantuml diagrams from go sources

Usage:
go-plantuml [command]

Available Commands:
completion Generate the autocompletion script for the specified shell
generate Generate a plantuml diagram from given paths
help Help about any command

Expand All @@ -30,20 +33,22 @@ Flags:
-t, --toggle Help message for toggle

Use "go-plantuml [command] --help" for more information about a command.

```

```bash
Generate a plantuml diagram from given paths

Usage:
go-plantuml generate [flags]

Flags:
-d, --directories strings the go source directories (default [.])
-x, --exclude string exclude file matching given regex expression, not used if using -f flag
-f, --files strings the go source files
-h, --help help for generate
-l, --left-to-right display the UML diagram left to right (default: top to bottom)
-o, --out string the graphfile (default "graph.puml")
-r, --recursive traverse the given directories recursively
-x, --exclude exclude file matching given regex expression, not used if using -f flag
```
## Example
Expand Down

0 comments on commit 97239d4

Please sign in to comment.