tours

1 files changed, 38 insertions, 10 deletions

diff --git a/README.gmi b/README.gmi
index 4dfb32d..0264565 100644
--- a/README.gmi
+++ b/README.gmi
@@ -1,5 +1,32 @@
 # X-1: fly around the small web at the speed of sound
 
+```ASCII art image of a Bell X-1 in flight
+                                                                                    ...       
+                                                                                  *=:::.      
+                                                         ---======-              -+-.....     
+                                                         .#@@@@@@@=             .+=-:....:++  
+                                                        +@@@@@@@@#              :-::.. ...*+  
+                                                      :%@@@@@@@@@.             =*+++==:....   
+                                                    .*@@@@@@@@@@=            -#%###**++-:..   
+                                                   -@@@@@@@@@@@%     .::-=*#@@#*#@@@@@@@%-.   
+                                  ..:::----=====++#@@@@@@@@@@@@%%%@@@@@@@@@@%%#**@@@@@@@=     
+                         .-+#%%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@-      
+                        =*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@##%@@*%@@@@@@@@@@-  ..   
+               -+*.     .#@@@@@@@@@@@@@@@@@@@@@@@@@@@%@@@@@@%%%%###- =- .=.==----==--:...     
+    ...:::::=#@@@@#**+*##@@@#*%%%%%%%%##############******+==-:-=-:.-==-:..   ...             
+             .:.:-==++++====::-----::---:-+%@@@@@@@@@@@@@#-...                                
+                       .  ...............=@@@@@@@@@@@@@@+....                                 
+                                        -@@@@@@@@@@@@@#.                                      
+                                       -@@@@@@@@@@@@%-                                        
+                                      -@@%%##@@@@@@=                                          
+                                     =%++*=-=%@@@*.                                           
+                                    =--*%%%::#@#:                                             
+                                   *@+=#-+*%@%-                                               
+                                 .*%****###@+.                                                
+                       ::..:::.::*@@@%%%%%#:                                                  
+                                                                                              
+```
+
 ## Prior art
 
 => gemini://mozz.us/journal/2021-01-01.gmi Mozz post on gemini client navigation
@@ -28,9 +55,9 @@ The default action for a completely empty command is "print", which will display
 * hi[story]: display the current history
 * p[rint]: display the current page
 * l[inks]: filter the page down to just a list of its links
-* |<shell command>: pipe the page's content through any shell command, executed with "sh -c"
+* pi[pe] <shell command>, or |<shell command>: pipe the page's content through any shell command, executed with "sh -c"
 * s[ave] <path>: save the page's content at a particular filesystem path
-* h[elp] [<command>]: show a help screen, optionally the one about a specific command
+* h[elp] [<topic>]: show a help screen
 * m[ark]: bookmarks, see below
 * t[our]: tours, seee below
 * q[uit]: exit the browser
@@ -42,9 +69,9 @@ Commands which take URLs can take them in a variety of forms:
 * relative URLs interpreted relative to the current page
 * "." always refers to the current page's URL
 * positive integers - the link index shown next to links on the current page
-* "m:<name>" - the link saved by a mark with a specific name
-* "t:<N>" - the URL in the default tour at index N
-* "t<X>:<N>" - The URL in the X tour at index N
+* "m:<name>" - the link saved by a mark with a specific name (or unique prefix of a mark name)
+* "t:<N>" - the URL in the current tour at index N
+* "t[<X>]:<N>" - The URL in the named X tour at index N
 
 The "tour add" command additionally also supports ranges of URLs in these forms:
 * "x-y" where x and y are integers, this expands to the range of links in the current page from x to y, inclusive on both ends
@@ -80,14 +107,14 @@ On any other nagivation, this context is cleared and next/previous actions won't
 * "tour sh[ow]" prints the current tour and where we currently are
 * "tour c[lear]" empties the current tour
 
-* "tour l[ist]" lists the default tour and any non-empty letter tours
+* "tour l[ist]" lists the default tour and any non-empty named tours
 * "tour p[revious]" goes back to the previous link in the tour
 * "tour g[o] i" takes an index and jumps to that position in the tour
 
-* "tour s[et] x" takes a single lower-case alphabetic character to select *which* tour should become active
-* without this letter, it re-selects the default tour
-* the default tour is the empty one. it is always active and empty upon startup
-* the other letter-identified tours have their state preserved when the program exits
+* "tour s[et] x" takes a name to select *which* tour should become active - any unique prefix will work, but the precise name will be used if it doesn't match any existing tour
+* without this name it re-selects the default tour
+* the default tour is always active and empty upon startup
+* the named tours have their state preserved upon any change to them
 
 ## Config file
 
@@ -95,6 +122,7 @@ The config file is located at XDG_DATA_HOME/x-1/config.toml. This is usually und
 
 It contains the following configuration options:
 
+* vim_keys (bool): whether to activate vim keybindings for the readline prompt. default "true"
 * default_scheme (string): the URL scheme to use in the "go" command when none is provided. default "gemini"
 * soft_wrap (int): the number of columns to wrap, or -1 to not add soft wrapping. default 72
 * download_folder (string): path at which to store files saved by the "save" command. default $HOME