From def44ef6d5e8e5b6d4fc2deaa75044ff4961c227 Mon Sep 17 00:00:00 2001 From: NerdyPepper Date: Tue, 10 Jul 2018 19:13:07 +0530 Subject: Add instructions --- readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/readme.md b/readme.md index c4a06c6..fdbb6ff 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,19 @@ # Taizen Browse Wikipedia pages from the command line. + +## Installation + +```shell +git clone https://github.com/nerdypepper/taizen +cd taizen +cargo run +``` + +## Usage + +Taizen uses a stack like model. Articles are opened on a new layer, and traversing the +stack involves popping the uppermost layer. +Hit `s` to search +Hit `q` to quit +Hit `t` to pop a layer from the article stack -- cgit v1.2.3