summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index dee857b..62018c2 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@ posting to NNTP servers. It's dead simple and lacks any sort of fancy TUI,
opting instead for an interface inspired by the Unix philosophy: posts are read
from stdin, and are written either to stdout or to text files in a directory.
+You _probably_ don't want to use it in its current state.
+
## Installation
`brisket` is self-contained and depends only on Hy core and the Python standard
@@ -81,6 +83,18 @@ $ brisket describe-group junk
Unfiled articles (no posting).
```
+### Reading
+
+Posts can be fetched with the `fetch-posts` command. Without any additional
+arguments, this will fetch *every* post on the server, which probably isn't what
+you want. You can specify a specific group and article ID to fetch.
+Additionally, if "-" is in the argument list, the article will be printed to
+stdout.
+
+### Posting
+
+Posts can be posted with the `post-article` command.
+
## Why the name?
I couldn't come up with a better name, and there's little in the world that