Skip to content

Commit

Permalink
docs(README): update with arguments example
Browse files Browse the repository at this point in the history
  • Loading branch information
fjcaetano committed Jul 16, 2019
1 parent 01abaf0 commit 2711e49
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# ios-simulator-gif
📱 ios-simulator-gif
---

Record a gif from your iOS simulator in a jiffy

![Example GIF](example.gif?raw=true)

### Instalation
## Installation

Assuming that you have [Homebrew](https://brew.sh/) installed, execute the following steps:

Expand All @@ -20,10 +21,27 @@ $ brew tap fjcaetano/ios-simulator-gif https://github.com/fjcaetano/ios-simulato
$ brew install fjcaetano/ios-simulator-gif/ios-simulator-gif
```

### Usage
## Usage

```sh
$ ios-simulator-gif [filename]
$ ios-simulator-gif [options] {out_file} {-- [ffmpeg options]}
```

| Options | Description | Default value |
| ------------------- | ------------------------- | :-------------: |
| -r, --rate | Framerate of the output | `6` |
| -f, --format | Output format | `gif` |
| -vf, --video-filter | Video filter for `ffmpeg` | `scale=320:-1` |
| -h, --help | Outputs helper message | N/A |

If no file name is given, it will save the gif to `./simulator.gif`

### Sending extra arguments to `ffmpeg`

If you need to send extra arguments to `ffmpeg`, everything sent after double slashes (`--`) will be
sent to `ffmpeg` as arguments:

```sh
$ ios-simulator-gif -r 30 example.gif -- -b 128k
```

If no file name is given, it will save the gif to `./simulator.gif`

0 comments on commit 2711e49

Please sign in to comment.