aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNerdyPepper <[email protected]>2018-07-10 14:43:07 +0100
committerNerdyPepper <[email protected]>2018-07-10 14:43:07 +0100
commitdef44ef6d5e8e5b6d4fc2deaa75044ff4961c227 (patch)
tree27c5367882309b3daaa9f552a562ab8561cd8621
parent85e427014b280de7c14e1244b553b651033b5823 (diff)
Add instructions
-rw-r--r--readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index c4a06c6..fdbb6ff 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,19 @@
1# Taizen 1# Taizen
2 2
3Browse Wikipedia pages from the command line. 3Browse Wikipedia pages from the command line.
4
5## Installation
6
7```shell
8git clone https://github.com/nerdypepper/taizen
9cd taizen
10cargo run
11```
12
13## Usage
14
15Taizen uses a stack like model. Articles are opened on a new layer, and traversing the
16stack involves popping the uppermost layer.
17Hit `s` to search
18Hit `q` to quit
19Hit `t` to pop a layer from the article stack