From dd11ee48361469049d3960764d80c617c3015040 Mon Sep 17 00:00:00 2001 From: "Jakob L. Kreuze" Date: Sat, 27 Apr 2019 15:45:29 -0400 Subject: Update documentation --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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 -- cgit v1.3