Skip to content

Commit

Permalink
docs(readme): update readme for v2
Browse files Browse the repository at this point in the history
  • Loading branch information
ilicmarko committed May 12, 2019
1 parent 77a1eb8 commit a955cd3
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

A really small utility to extract images from Chrome Timeline.

## Setup
## Installation

```bash
yarn global add devtools-timeline-images
Expand All @@ -16,16 +16,33 @@ npm i -g devtools-timeline-images

## Usage

CLI takes to arguments `-i` and `-o`:
* `-i` or `--input` - Specify the input JSON file.
* `-o` or `--output` - Specify the output folder.
As of v2 CLI includes and alias for the name, `dte` (Devtools Timeline Export). This has been changed as in the future
there is a plan to export videos, not only images.

### Image

```bash
dte images <input> [options]

Generate sequence of images.

Options:
--version Show version number [boolean]
--output, -o Path to JSON file generated by Chrome. [string] [required]
-h, --help Show help [boolean]
```

Also you can generate images with an alias `i`, like this: `dte i <input> [options]`.

## Options
- `-o` or `--output` - Specify the output folder.

*Note: If the output directory does not exist the CLI will create it.*

## Example

```bash
devtools-timeline-images -i ./example-site.json -o ./images
dte i ./example-site.json -o ./images
```

## Save a recoding
Expand Down

0 comments on commit a955cd3

Please sign in to comment.