Skip to content

Commit

Permalink
Update README with cli usage
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeljoseph committed Oct 14, 2013
1 parent 1762afa commit 88a7fbe
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,28 @@ Install `remarkable`:

## CLI

>> docopt
Run the cli:

```
remarkable.
Usage:
remarkable [options] remark <path-to-markdown-file>
remarkable [options] reveal <path-to-markdown-file>
remarkable -h | --help
Options:
--debug Debug.
-h --help Show this screen.
```

Example:
```
remarkable reveal ../application-to-platform/application-to-platform.md
INFO:remarkable.cli:Created ../application-to-platform/application-to-platform.md.html
```

## Documentation

Expand Down

0 comments on commit 88a7fbe

Please sign in to comment.