Skip to content

Commit

Permalink
Cleanup README
Browse files Browse the repository at this point in the history
  • Loading branch information
humphd committed Sep 19, 2012
1 parent b9ea968 commit 420ab8c
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Expand Up @@ -13,26 +13,29 @@ installs the `webvtt` shell command.

## Examples

```
$ webvtt.js file.vtt
Validate a single file, printing error messages, if any:

$ webvtt file.vtt

$ webvtt.js file1.vtt file2.vtt
Validate two files, printing error messages, if any:

$ webvtt.js -s file.vtt
```
$ webvtt file1.vtt file2.vtt

Validate a single file, don't print error messages:

$ webvtt -s file.vtt

## Synopsis

```
$ webvtt
$ webvtt
Usage: webvtt [options] <file...>
Usage: webvtt.js [options] <file...>
Options:
Options:
-h, --help output usage information
-V, --version output the version number
-s, --silent don't print errors messages
-h, --help output usage information
-V, --version output the version number
-s, --silent don't print errors messages
```

## Output
Expand All @@ -46,8 +49,8 @@ filename:linenumber.column: message
For example:

```
$ webvtt file.vtt
file.vtt:1.0: No valid signature. (File needs to start with "WEBVTT".)
$ webvtt file.vtt
file.vtt:1.0: No valid signature. (File needs to start with "WEBVTT".)
```

## Thanks
Expand Down

0 comments on commit 420ab8c

Please sign in to comment.