From 68c21b76720c966c6a1bf155fecc42562d85bb39 Mon Sep 17 00:00:00 2001 From: Alexander Yakovlev Date: Sun, 13 May 2018 14:12:34 +0700 Subject: [PATCH] updated readme --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8af896d..81f155e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ -# Interactive Fiction news parser -Originally a parser for Russian Interactive Fiction, now it supports English games too. +# A set of utilities for tracking text-based game releases +Originally a parser for Russian Interactive Fiction, now it's much more than that. -Its function is simple: it scans some game hosting sites, finds the new games (published in the last week) and prints a neat list in Markdown format. All automatic. +There are three executable PHP scripts here that serve different functions but share the code. -The `russian.php` is Russian sites, `english.php` is English sites. +## run.php +This one was the first. +Its function is simple: it scans some game hosting sites, finds the new games (published during the last week) and prints a neat list in Markdown or HTML format. +All automatic. + +## bot.php +This one does the same in continuous fashion, posting the feed to Mastodon or Telegram. + +## wiki.php +And this one makes wiki pages for the [IFWiki](http://ifwiki.ru). +It uses Russian IFWiki syntax and templates but it would be easy to alter for the English IFWiki as well if you'd want that.