revised readme to mimic man page

README.md

@@ -1,15 +1,69 @@
-# todo [![Build Status](https://travis-ci.com/jamestomasino/todo.svg?branch=master)](https://travis-ci.com/jamestomasino/todo) ![GitHub](https://img.shields.io/github/license/jamestomasino/todo.svg)
+```
+TODO(1)                           General Commands Manual                          TODO(1)
 
-**todo** is a minimalistic to-do manager for the shell. It supports:
+NAME
+       todo - a minimalist todo list manager
 
-- auto-archiving completed tasks with datetime stamp
-- regular expressions support for task completion
-- command-completion
-- `tmux` session name integration
+SYNOPSIS
+       todo [-vhex] [-a "todo item"] [-d todo-number] [-d "todo phrase"]
 
-See man page for more details.
+DESRIPTION
+       todo  is a simple, minimalist todo list manager. Users can add items to a todo list
+       or delete them. Deleted items are archived and can be reviewed.
 
-## License
+       The default location of the todo list can be set with the  TODO  environment  vari‐
+       able. If unset, a the default file is ~/todo.txt.
 
-[GPL3](LICENSE)
+       If  todo  is used within a tmux session, the filename of the todo list inherits the
+       name of the current session. This allows for unique todo lists based on  tmux  con‐
+       text.
 
+       The options are as follows:
+
+       no parameters
+              If no parameters are passed to todo, then the current todo list will be dis‐
+              played to standard out.
+
+       -a  quoted_todo_item
+              Add a new todo list item
+
+       -d  item_number_or_phrase
+              Delete a todo list item by its number or by a string.  If a string  is  pro‐
+              vided,  any todo list item that matches that string will be removed. Deleted
+              items are moved to the archive.
+
+       The archive file is named identically to the todo file with the exception of a .ar‐
+       chive added before the extension. For example, todo.txt would have an archive named
+       todo.archive.txt in the same folder.
+
+       -e     Open the todo file in your editor.
+
+       -x     Display the archive file.
+
+       -v     Display current version information.
+
+       -h     Show the help.
+
+EXIT STATUS
+       The todo utility exits 0 on success, and >0 if an error occurs.
+
+EXAMPLES
+       todo   Displays the current todo list
+
+       todo -a `this is a new todo list item'
+              Adds a new item to the current todo list
+
+       todo -d 3
+              Deletes item #3 from the current todo list
+
+       todo -x
+              Shows the archive for the current todo list
+
+BUGS
+       Report issues at the git repository at https://github.com/jamestomasino/todo
+
+AUTHOR
+       James Tomasino <james (at) tomasino (dot) org>
+
+v2020.01.21                           21 January 2020                              TODO(1)
+```

todo

@@ -19,7 +19,7 @@
 
 #-----------------------------------------------------------------------
 
-version="v2020.01.21"
+version="2020.07.10"
 
 show_help() {
   cat > /dev/stdout << END

todo.1

@@ -1,4 +1,4 @@
-.TH TODO 1 "21 January 2020" "v2020.01.21"
+.TH TODO 1 "10 July 2020" "2020.07.10"
 
 .SH NAME
 todo \- a minimalist todo list manager
@@ -80,6 +80,11 @@ Deletes item #3 from the current todo list
 .B todo -x
 Shows the archive for the current todo list
 
+.SH LICENSE
+GNU General Public License v3.0 or later at
+.TP
+.B https://www.gnu.org/licenses/gpl-3.0-standalone.html
+
 .SH BUGS
 Report issues at the git repository at
 .B https://github.com/jamestomasino/todo