https://github.com/exyte/ReadabilityKit

Preview extractor for news, articles and full-texts in Swift
https://github.com/exyte/ReadabilityKit

extract preview swift swift-package-manager

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/exyte/ReadabilityKit
• Owner: exyte
• License: mit
• Archived: true
• Created: 2016-06-08T13:20:48.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-05-18T07:09:44.000Z (over 1 year ago)
• Last Synced: 2024-07-20T03:53:04.613Z (about 2 months ago)
• Topics: extract, preview, swift, swift-package-manager
• Language: Swift
• Homepage:
• Size: 18.7 MB
• Stars: 830
• Watchers: 37
• Forks: 76
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ios - ReadabilityKit - Metadata extractor for news, articles and full-texts in Swift. (Utility / Web View)
• awesome-swift - ReadabilityKit - Preview extractor for news, articles and full-texts. (Libs / Utility)
• awesome-swift - ReadabilityKit - Preview extractor for news, articles and full-texts. (Libs / Utility)
• awesome-ios-star - ReadabilityKit - Metadata extractor for news, articles and full-texts in Swift. (Utility / Web View)
• fucking-awesome-swift - ReadabilityKit - Preview extractor for news, articles and full-texts. (Libs / Utility)
• awesome-swift - ReadabilityKit - Preview extractor for news, articles and full-texts in Swift ` 📝 a year ago ` (Utility [🔝](#readme))

README

        




ReadabilityKit


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


___

 We are a development agency building

  phenomenal apps.


 

![](https://img.shields.io/github/v/tag/exyte/popupView?label=Version)

[![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)

[![Cocoapods Compatible](https://img.shields.io/badge/cocoapods-Compatible-brightgreen.svg)](https://cocoapods.org/pods/ExyteAnimatedTabBar)

[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-0473B3.svg?style=flat)](https://github.com/Carthage/Carthage)

# !Project is now archived!

No further maintenance will be performed

## Features

Extracts:

- [x] Title

- [x] Description

- [x] Top image

- [x] Top video

- [x] Keywords

- [x] Date

## Usage

```swift

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](http://cocoapods.org)

```ruby

pod 'ReadabilityKit'

```

### [Carthage](http://github.com/Carthage/Carthage)

```ogdl

github "exyte/ReadabilityKit"

```

### Manually

1. Install [Ji XML parser](https://github.com/honghaoz/Ji#manually).

2. Download and drop all files from Sources folder in your project.

## Development Environment Setup

1. Install [Carthage](https://github.com/Carthage/Carthage#installing-carthage).

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

```bash

carthage bootstrap --platform 

```

## 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.