diff options
author | NerdyPepper <[email protected]> | 2018-07-10 14:43:07 +0100 |
---|---|---|
committer | NerdyPepper <[email protected]> | 2018-07-10 14:43:07 +0100 |
commit | def44ef6d5e8e5b6d4fc2deaa75044ff4961c227 (patch) | |
tree | 27c5367882309b3daaa9f552a562ab8561cd8621 | |
parent | 85e427014b280de7c14e1244b553b651033b5823 (diff) |
Add instructions
-rw-r--r-- | readme.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -1,3 +1,19 @@ | |||
1 | # Taizen | 1 | # Taizen |
2 | 2 | ||
3 | Browse Wikipedia pages from the command line. | 3 | Browse Wikipedia pages from the command line. |
4 | |||
5 | ## Installation | ||
6 | |||
7 | ```shell | ||
8 | git clone https://github.com/nerdypepper/taizen | ||
9 | cd taizen | ||
10 | cargo run | ||
11 | ``` | ||
12 | |||
13 | ## Usage | ||
14 | |||
15 | Taizen uses a stack like model. Articles are opened on a new layer, and traversing the | ||
16 | stack involves popping the uppermost layer. | ||
17 | Hit `s` to search | ||
18 | Hit `q` to quit | ||
19 | Hit `t` to pop a layer from the article stack | ||