diff --git a/README.md b/README.md new file mode 100644 index 0000000..d39e4b6 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# yapfaq + +**yapfaq** can post FAQs from text files to Usenet at configurable intervals and automatically adds the necessary headers. + +## Description + +With **yapfaq**, FAQs or other texts can be posted regularly (every x days, weeks, months or years) to one or more newsgroups. Posting frequency as well as the necessary headers - including the format of the `Message-ID:` headers that will be generated - can be defined in a configuration file. `Expires:` and `Supersedes:` will be set automatically by the script. + +The text can either be posted via NNTP or piped to another programme (like `inews` or `tinews.pl`). + +## More information + +Please see the [distribution page](https://th-h.de/net/software/yapfaq/) (in German).