From f5c3ddb6978462da75d33006988eeb2680a1e361 Mon Sep 17 00:00:00 2001
From: "Jakob L. Kreuze" <zerodaysfordays@sdf.lonestar.org>
Date: Fri, 26 Apr 2019 19:50:46 -0400
Subject: Add cursory documentation to README.md

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 59 insertions(+), 3 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index f1e5d70..dee857b 100644
--- a/README.md
+++ b/README.md
@@ -12,19 +12,75 @@ library. Provided that both Hy and Python are installed, you should be able to
 invoke `brisket` in the following ways.
 
 ```sh
-chmod u+x brisket.hy
+$ chmod u+x brisket.hy
 
 # Install globally.
-cp brisket.hy /usr/local/bin/brisket
+$ cp brisket.hy /usr/local/bin/brisket
 
 # Or
 
 # I'd rather just run it from the repository.
-./brisket.hy
+$ ./brisket.hy
 ```
 
 ## Usage
 
+Running `brisket` without any arguments will give a list of recognized commands.
+
+```sh
+$ brisket
+usage: /home/jakob/.bin/brisket [command] [args]
+recognized commands:
+  - describe-group
+  - help
+...
+```
+
+The documentation for any command can be obtained with the `help` command.
+
+```sh
+$ brisket help describe-group
+Describe the first group matching the pattern.
+
+usage: describe-groups [pattern]
+```
+
+### Configuration
+
+Upon running `brisket` for the first time, a default configuration file will be
+written to `$HOME/.config/brisket/config.ini`. The hostname for the NNTP server
+you wish to connect to can be specified here. Alternatively, the hostname can be
+specified with the `$NNTPSERVER` environment variable.
+
+Currently, the only way to specify credentials for authenticating with the NNTP
+server is with a line in `.authinfo.gpg`. See
+[here](https://www.emacswiki.org/emacs/GnusAuthinfo) for more information.
+
+### Exploration
+
+A list of groups available on the server can be obtained with the `list-groups`
+command.
+
+```sh
+$ brisket list-groups
+control
+control.cancel
+control.checkgroups
+control.newgroup
+control.rmgroup
+junk
+orbitalfox
+orbitalfox.test
+...
+```
+
+Descriptions, if available, can be obtained with the `describe-group` command.
+
+```sh
+$ brisket describe-group junk
+Unfiled articles (no posting).
+```
+
 ## Why the name?
 
 I couldn't come up with a better name, and there's little in the world that
-- 
cgit v1.3