Skip to content

Commit

Permalink
Fix garbled flags in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
denisbrodbeck committed Nov 24, 2017
1 parent 687f521 commit 1d94cf6
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,6 @@ import "github.com/denisbrodbeck/sqip"

## CLI usage

> sqip [-n <int>] [-o <path>] [options...] <file>
> Flags:
> -n <int> number of primitive SVG shapes (default: 8)
> -o <path> save the placeholder SVG to a file (default: empty)
> Options:
> -mode <int> shape type (default: 0)
> -alpha <int> color alpha (use 0 to let the algorithm choose alpha for each shape) (default: 128)
> -bg <hex> background color as hex (default: avg)
```bash
# Generate a SVG placeholder and print an example <img> tag to stdout
sqip input.png
Expand All @@ -59,6 +50,19 @@ sqip -o output.svg input.png
sqip -n 4 input.jpg
```

All available flags:

```
sqip [-n <int>] [-o <path>] [options...] <file>
Flags:
-n <int> number of primitive SVG shapes (default: 8)
-o <path> save the placeholder SVG to a file (default: empty)
Options:
-mode <int> shape type (default: 0)
-alpha <int> color alpha (use 0 to let the algorithm choose alpha for each shape) (default: 128)
-bg <hex> background color as hex (default: avg)
```

## API

Here is an example app:
Expand Down

0 comments on commit 1d94cf6

Please sign in to comment.