Popularity
6.2
Growing
Activity
5.9
-
697
34
54

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: HTML
Tags: Utility     Web     Parser     Metadata     Extractor    
Latest version: v0.7.3

ReadabilityKit alternatives and similar libraries

Based on the "Utility" category

Do you think we are missing an alternative of ReadabilityKit or a related project?

Add another 'Utility' Library

README

ReadabilityKit

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


We are a development agency building phenomenal apps.

CI Status Version Carthage Compatible License Platform

Features

Extracts:

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

    Requirements

  • iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+

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

To install ReadabilityKit, simply add the following line to your Podfile

Swift 5.x:

pod 'ReadabilityKit'

Swift 4.x:

pod 'ReadabilityKit' '0.7.1'

Swift 3.x:

pod 'ReadabilityKit', '0.6.0'

Carthage

To integrate ReadabilityKit into your Xcode project using Carthage, specify it in your Cartfile

Swift 5.x:

github "exyte/ReadabilityKit"

Swift 4.x:

github "exyte/ReadabilityKit" == 0.7.1

Swift 3.x:

github "exyte/ReadabilityKit" == 0.6.0

Manually

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

License

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


*Note that all licence references and agreements mentioned in the ReadabilityKit README section above are relevant to that project's source code only.