Skip to content
This repository has been archived by the owner on May 16, 2022. It is now read-only.

Commit

Permalink
Merge pull request #15 from remove-bg/extra-examples
Browse files Browse the repository at this point in the history
Add extra examples to README
  • Loading branch information
groe authored Jun 10, 2020
2 parents 530c6ef + 0d3b511 commit 58dcde2
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,22 @@ Please see the [API documentation][api-docs] for further details.
- `--channels`
- `--bg-color`
- `--format` (default: `png`)
- `--extra-api-options` for forwarding any unlisted/new options to the API
- Formatted as a URI encoded string (`=` between key/value, delimited with `&`)
- e.g. `--extra-api-options 'crop=true&add_shadow=true'`

## Examples

```sh
# Producing a JPG with a grey background at the path: processed/subject.jpg
removebg subject.jpg --format jpg --bg-color 7a7a7a --output-directory processed

# Producing a large transparent PNG image up to 25 megapixels
removebg large.jpg --size full --format png

# Processing a car image with additional API options
removebg car.jpg --type car --extra-api-options 'add_shadow=true&semitransparency=true'
```

## Development

Expand Down

0 comments on commit 58dcde2

Please sign in to comment.