Skip to content

Commit a21af41

Browse files
committed
README and GIF
1 parent d2912b8 commit a21af41

File tree

2 files changed

+41
-2
lines changed

2 files changed

+41
-2
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,48 @@
22

33
[![Build Status](https://travis-ci.org/passy/givegif.svg?branch=master)](https://travis-ci.org/passy/givegif)
44

5-
**Work In Progress**
5+
**WARNING: Some of the steps in the readme don't quite reflect reality yet.**
66

7-
> Find and display GIFs on the command line.
7+
> Find and display GIFs from the command line.
8+
9+
## Demo
10+
11+
![](media/usage.gif)
12+
13+
## Usage
14+
15+
```
16+
Usage: givegif [-n|--no-preview] ([-s|--search ARG] | [-t|--translate ARG] |
17+
[RANDOM_TAG])
18+
Find GIFs on the command line.
19+
20+
Available options:
21+
-h,--help Show this help text
22+
-n,--no-preview Don't render an inline image preview.
23+
-s,--search ARG Use search to find a matching GIF.
24+
-t,--translate ARG Use translate to find a matching GIF.
25+
-V,--version Show version information
26+
```
27+
28+
## Installation
29+
30+
Check out the latest [releases](https://github.com/passy/givegif/releases) for
31+
precompiled binaries.
32+
33+
Alternatively, feel free to build it yourself with
34+
[stack](http://haskellstack.org).
35+
36+
37+
```bash
38+
$ stack install givegif
39+
$ givegif -V
40+
givegif 1.0.0.0
41+
```
42+
43+
## Known Issues
44+
45+
Even though I tried to make this work with screen/tmux, it still glitches out
46+
every now and then. If you can figure out why, please let me know.
847

948
## License
1049

media/usage.gif

11.6 MB
Loading

0 commit comments

Comments
 (0)