Skip to content
This repository was archived by the owner on Jun 21, 2022. It is now read-only.

README.md

Latest commit

 

History

History
77 lines (52 loc) · 2.6 KB

README.md

File metadata and controls

77 lines (52 loc) · 2.6 KB

Readability-Objective-C

Determine readability and comprehension difficulty for contemporary English text.

  • iOS reference platform, 9.3 minimum version.
  • Example app and tests included.

Metrics Included

Installation

CocoaPods is the easiest way to use this project. Add the following to your project Podfile:

pod 'Readability-Objective-C', :git => 'https://github.com/brackendev/Readability-Objective-C.git'

It is a good idea to specifiy the commit. For example:

pod 'Readability-Objective-C', :git => 'https://github.com/brackendev/Readability-Objective-C.git', commit => '47d2b475ba7f4b3169321d61df552dd2a912cee9'

Example Usage

  1. Import it:

    #import <Readability-Objective-C/Readability.h>

  2. Use it:

    [Readability automatedReadabilityIndexForString:@"Text"];
[Readability colemanLiauIndexForString:@"Text"];
[Readability fleschKincaidGradeLevelForString:@"Text"];
[Readability fleschReadingEaseForString:@"Text"];
[Readability gunningFogScoreForString:@"Text"];
[Readability smogGradeForString:@"Text"];

Note: See the example view controller.

Acknowledgements

This project makes use of the following third-party libraries:

Ports

Author

Bracken Spencer

License

Readability-Objective-C is released under the MIT license. See the LICENSE file for more info.