diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f42bc6e --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +falseknees-atom +=============== + +A simple Lua script that generates an Atom Feed of the fantastic +[False Knees][falseknees] webcomic. + +Requirements +------------ + +You need to have [Lua][lua] (5.3 or later) and [LuaSocket][luasocket] installed. + +Usage +----- + +Executing `falseknees-atom.lua` will write an Atom Feed with all the comic +strips to stdout. When you are using a feed reader that can take it's input from +an external binary, you can just point it to the script. E.g. here is an entry +for [Newsboat][newsboat]'s `~/.newsboat/urls` that I use: + + exec:~/src/falseknees-atom/falseknees-atom.lua + +`~/src/falseknees-atom/` is where this repo lives on my machine. Adapt the path +to fit wherever you put it. + +Why? +---- + +I want to know when the latest comic arrives, but +<http://falseknees.com/rss.xml> does not seem to get updated any more :(. + + +[falseknees]: https://falseknees.com +[lua]: https://lua.org +[luasocket]: http://w3.impa.br/~diego/software/luasocket/home.html +[newsboat]: https://newsboat.org/ |