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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brackendev authored Jul 19, 2019
1 parent 5aea677 commit 160a2f5
Showing 1 changed file with 33 additions and 11 deletions.
44 changes: 33 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,9 @@ Readability-Objective-C

**Metrics to determine readability and comprehension difficulty for contemporary English text.**

* [iOS](https://en.wikipedia.org/wiki/IOS) reference platform.
* [iOS](https://en.wikipedia.org/wiki/IOS) reference platform, 9.3 minimum version.
* Example app and tests included.

## Installation

Git clone this repository. [objC-syllable-counter](https://github.com/brackendev/objC-syllable-counter.git) submodule is required, therefore be sure to clone like this:

````bash
git clone --recursive https://github.com/brackendev/Readability-Objective-C.git
````

## Metrics Included

* [Automated Readability Index](http://en.wikipedia.org/wiki/Automated_Readability_Index)
Expand All @@ -25,9 +17,39 @@ git clone --recursive https://github.com/brackendev/Readability-Objective-C.git
* [Gunning Fog Index](http://en.wikipedia.org/wiki/Gunning_fog_index)
* [SMOG Grade](http://en.wikipedia.org/wiki/SMOG)

## Usage
## Installation

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

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

## Example Usage

1. Import it:

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

2. Use it:

```Objective-C
[Readability automatedReadabilityIndexForString:@"Text"];
[Readability colemanLiauIndexForString:@"Text"];
[Readability fleschKincaidGradeLevelForString:@"Text"];
[Readability fleschReadingEaseForString:@"Text"];
[Readability gunningFogScoreForString:@"Text"];
[Readability smogGradeForString:@"Text"];
```

## Acknowledgements

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

See the [view controller](https://github.com/brackendev/Readability-Objective-C/blob/master/Readability-Objective-C%20Example/Readability-Objective-C%20Example/Classes/ViewController.m) in the example app.
* [objC-syllable-counter](https://github.com/brackendev/objC-syllable-counter.git)
* [RegexKitLite](http://regexkit.sourceforge.net/RegexKitLite/)

## Ports

Expand Down

0 comments on commit 160a2f5

Please sign in to comment.