Skip to content

poliorcetics/ffn-dl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ffn-dl

Swift5 compatible SPM compatible

ffn-dl is a pure Swift library to download fanfictions from differents sites.

Features

ffn-dl ships with

  • A Story protocol allowing you to implement your own handler for any site.
  • Author, Chapter and Universe types, easily customisable.
  • Out-of-the-box handling of fanfiction.net.
  • Update fonctionnality that allows you to update a story without downloading fully once again.
  • Metada handling.

Installation

You will need to have access to Swift 5.1 at the very least to use this package, as well as XCode 11.

The Swift Package Manager automates the distribution of Swift code. To use ffn-dl with SPM, add a dependency to your Package.swift file:

let package = Package(
  dependencies: [
    .package(url: "https://github.com/poliorcetics/ffn-dl.git", ...)
    ]
)

Note that Linux is not currently supported.

Building and testing

To build the project, once you have cloned it:

swift build

And to test it:

swift test

Note that this project is a library: you cannot run it.

License

See LICENSE at the root of the project.