ltetzlaff / ReadabilityKit

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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:

  • Title
  • Description
  • Top image
  • Top video
  • Keywords
  • 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

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'

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.

About

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

License:MIT License


Languages

Language:Swift 96.4%Language:Objective-C 2.1%Language:Ruby 1.5%