aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Winston2021-05-05 18:18:43 -0400
committerBen Winston2021-05-05 18:18:43 -0400
commit9ba40a0750c7bc7b49c1e0fce06cef32b7c75545 (patch)
tree295f88b47b22641cc5f419db361026f0c7483ad0 /README.md
parente52231e8a148f325bc4e14d17db4ec43599e61a7 (diff)
docfix: fleshed out readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 29 insertions, 15 deletions
diff --git a/README.md b/README.md
index 6ba4b06..08fd03b 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,38 @@
# roku-cli
-a command line remote for Roku
-
-## usage
-- [h]ome
-- [b]ack
-- [p]lay
-- [r]eplay
-- * (star)
-- arrow keys
-- enter key
-- < and > (rew and ff)
-- / (switch to typing mode, 'enter' to exit)
+a command line TUI remote for Roku
+
+## basic usage
+Keys on the left map to standard Roku remote buttons on the right
+* `h` -> Home
+* `b` -> Back
+* `p` -> Play/Pause
+* `r` -> Replay
+* `*` -> Options (star key)
+* arrow keys -> navigation
+* `ENTER` -> OK
+* `<` -> Rewind
+* `>` -> Fast-Forward
+
+To quit the application, type `q`.
+
+## typing mode
+In some instances, you may need to type something into a Roku screen
+(when searching or logging into a service, for example). This can be
+incredibly cumbersome using the standard navigation.
+
+To enter typing mode, press `/`, and you will see a cursor appear below
+the remote. At this point, all alphanumeric keys (and backspace) will
+be interpreted literally and sent to the Roku.
+
+To exit typing mode, press `ENTER` or `ESC`.
## install
-replace the default IP address in `roku.config` with the IP address of
-the roku. then run:
+Replace the default IP address in `roku.config` with the IP address of
+the Roku, then run:
```
make
sudo make install
```
-program can be started using `roku`
+Program can be started using `roku`.