Skip to content

Commit

Permalink
Better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jibolaberge committed Oct 23, 2016
1 parent 3173e84 commit 62a958d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,24 @@ npm install -g diagrams

# Usage

## watch
The diagrams CLI provides the `watch` command that will automatically generate the .svg visualization of each diagram file format it supports. Run the following:

Watches the current directory and generates an .svg file in the same directory as any found file.
```
diagrams watch
```

Same as above but also first generates all .svg files before starting watch process
```
diagrams watch --build
```

To provide the target directory to watch just pass it as an argument right after the `watch` command.
```
diagrams watch somedirectory --build
```

## flowchart
Documentation: [Flowchart.js ](http://flowchart.js.org/).

Expand Down

0 comments on commit 62a958d

Please sign in to comment.