From ff1bd221938f2b3fb4bb1d1f494001a3dd6d8218 Mon Sep 17 00:00:00 2001 From: Eli Schwartz Date: Thu, 18 Oct 2018 18:31:15 -0400 Subject: [PATCH] README.md: make it a little more descriptive --- README.md | 44 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 35 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9a7831e8..2465b4da 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,36 @@ -FanFicFare +[FanFicFare](https://github.com/JimmXinu/FanFicFare) ========== -[This is the repository for the FanFicFare project.](https://github.com/JimmXinu/FanFicFare) +FanFicFare makes reading stories from various websites much easier by helping +you download them to EBook files. -FanFicFare is the rename and move of the previous FanFictionDownLoader (AKA -FFDL, AKA fanficdownloader) project. +FanFicFare was previously known as FanFictionDownLoader (AKA +FFDL, AKA fanficdownloader). + +Main features: + +- Download FanFiction stories from over 150 different sites into ebooks. + [Supported sites list](https://github.com/JimmXinu/FanFicFare/wiki/SupportedSites). + +- Update existing EPUB format ebooks, downloading only new chapters. + +- Get Story URLs from Web Page. + +- Support for downloading images in the story text. (EPUB and HTML + only -- download EPUB and convert to AZW3 for Kindle) More details on + configuring images in stories and cover images can be found in the + [FAQs] or [this post in the old FFDL thread]. + +- Support for cover image. (EPUB only) + +- Optionally keep an Update Log of past updates (EPUB only). + +There's additional info in the project [wiki] pages. + +There's also a [FanFicFare maillist] for discussion and announcements. + +Getting FanFicFare +================== This program is available as a [calibre plugin](http://www.mobileread.com/forums/showthread.php?p=3084025), a @@ -20,9 +46,9 @@ pacman -S fanficfare or from git via the [AUR package](https://aur.archlinux.org/packages/fanficfare-git) (which will also update the calibre plugin, if calibre is installed). -There's additional info in the project -[wiki](https://github.com/JimmXinu/FanFicFare/wiki) pages. -There's also a [FanFicFare -maillist](https://groups.google.com/group/fanfic-downloader) for -discussion and announcements. + +[this post in the old FFDL thread]: https://www.mobileread.com/forums/showthread.php?p=1982785#post1982785 +[FAQs]: https://github.com/JimmXinu/FanFicFare/wiki/FAQs#can-fanficfare-download-a-story-containing-images +[FanFicFare maillist]: https://groups.google.com/group/fanfic-downloader +[wiki]: https://github.com/JimmXinu/FanFicFare/wiki