This repository has been archived on 2021-12-17. You can view files and clone it, but cannot push or open issues/pull-requests.
falseknees/README.md

27 lines
862 B
Markdown

# FalseKnees
This is definitely not real API for [FalseKnees](https://www.falseknees.com).
By that I mean to say FK does not *have* an API, so this is a glorified HTML parser.
Please be considerate of the fact that this is not a real API and so it is pulling entire HTML pages
to parse.
## Current Comic
[FalseKnees](https://www.falseknees.com) `/index.html` page contains a redirect to get the latest
comic number. This library leverages that page to get the current comic, **however** in an effort
to reduce HTTP calls against full HTML pages, the library has a built-in interval of 30 minutes.
This means that if you get the current comic at 12:00 and FK adds a new comic at 12:05, you
won't get the new current comic until 12:30.
Currently the following funcs retrieve the current comic number:
* `Random`
* `Current`
## License
[MIT](LICENSE)