ReadabilityKit

Preview extractor for news, articles and full-texts in Swift

Description

ReadabilityKit helps you to extract a relevant preview (title, description, image and video) from the URL.

The extraction goal is to try and get the best extraction from the article for servicing applications that need to show a preview of a web URL along with an image. Comparison with other libraries available here and why you should use ReadabilityKit instead of SwiftLinkPreview here.

Inspired by snacktory and newspaper.

Programming language: Swift

License: MIT License

Tags: Utility     Web     Parser     Metadata     Extractor    

Latest version: v0.7.4

README

ReadabilityKit

Preview extractor for news, articles and full-texts in Swift

---

We are a development agency building phenomenal apps.

Features

Extracts:

• [x] Title
• [x] Description
• [x] Top image
• [x] Top video
• [x] Keywords
• [x] Date

Usage

let articleUrl = URL(string: "https://someurl.com/")!
Readability.parse(url: articleUrl, completion: { data in
    let title = data?.title
    let description = data?.description
    let keywords = data?.keywords
    let imageUrl = data?.topImage
    let videoUrl = data?.topVideo
    let datePublished = data?.datePublished
})

To run the example project, clone the repo, and run pod install from the Example directory first.

Installation

CocoaPods

pod 'ReadabilityKit'

Carthage

github "exyte/ReadabilityKit"

Manually

1. Install Ji XML parser.
2. Download and drop all files from Sources folder in your project.

Development Environment Setup

1. Install Carthage.
2. Check out and build the project's dependencies:

carthage bootstrap --platform <name>

Requirements

• iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+

License

ReadabilityKit is available under the MIT license. See the LICENSE file for more info.