Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 2.45 KB

README.md

File metadata and controls

89 lines (59 loc) · 2.45 KB
Raw

ReadabilityKit

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

We are a development agency building phenomenal apps.




License: MIT Cocoapods Compatible Carthage Compatible

!Project is now archived!

No further maintenance will be performed

Features

Extracts:

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