updated readme
This commit is contained in:
parent
e414f61865
commit
68c21b7672
18
README.md
18
README.md
|
@ -1,6 +1,16 @@
|
||||||
# Interactive Fiction news parser
|
# A set of utilities for tracking text-based game releases
|
||||||
Originally a parser for Russian Interactive Fiction, now it supports English games too.
|
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.
|
||||||
|
|
Reference in a new issue