summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob L. Kreuze <zerodaysfordays@sdf.lonestar.org>2019-04-26 19:50:46 -0400
committerJakob L. Kreuze <zerodaysfordays@sdf.lonestar.org>2019-04-26 19:50:46 -0400
commitf5c3ddb6978462da75d33006988eeb2680a1e361 (patch)
treeaadd2132d5921ccb4a4fc373eeb5d86c98c4ad07 /README.md
parentcd3a0aa66cf9ce47b1f7d3812acf6f0c01569dd5 (diff)
Add cursory documentation to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 59 insertions, 3 deletions
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