From 49bd682c7108c23052fb2e8bca77274153764b9c Mon Sep 17 00:00:00 2001 From: Joakim Soderlund Date: Wed, 27 Jan 2021 16:24:58 +0100 Subject: [PATCH] Add introduction section to readme --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2704ff1..bd70d63 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ # Fimfarchive -Fimfarchive preserves stories from Fimfiction. +Fimfarchive aims to release all stories on Fimfiction as a single ZIP-file. The +archive contains not only stories, but also metadata such as tags, ratings, and +descriptions. It is organized by author and could be used for backup, offline +reading, or data mining. + +Releases can be found on Fimfarchive's [user profile] at [Fimfiction]. Note +that this is **not** an official Fimfiction project, so do not send questions +to Fimfiction staff. Instead, send a private message or post a comment to the +Fimfarchive user profile. + +A new version will be released each season via BitTorrent, approximately once +every three months. When suitable, an xdelta3 patch will also be provided for +users who do not wish to redownload unchanged stories. + +Note that the archive contains a large number of files. Unzipping it to your +file system may not be necessary if the archive is to be used together with +some application. If you are a developer, reading directly from the ZIP-file +may be preferable. + +This repository contains the code for updating and building the archive. While +the API is not guaranteed to be stable, it can also be used as a library for +easy access to stories and metadata within the archive. + +[Fimfiction]: https://www.fimfiction.net +[user profile]: https://www.fimfiction.net/user/116950/Fimfarchive