The preferred method of installation is through CocoaPods. Just add the following to your Podfile:
pod 'RNTextStatistics', '~> 1.0.0'
Or if you want to install manually, simply drag the RNTextStatistics folder into your project. Then import only the RNTextStatistics category on NSString into either individual files or your Prefix Header.
All readability tests and statistics caluclations are available simple as Categories on NSString which means you can just call them on a string. There is nothing fancy going on here.
- (float)fleschKincaidReadingEase; - (float)fleschKincaidGradeLevel; - (float)gunningFogScore; - (float)colemanLiauIndex; - (float)smogIndex; - (float)automatedReadabilityIndex;
NSString *raw = @"Quam Nullam Fermentum Cras Ornare"; float fleschEase = [raw fleschKincaidReadingEase]; // 49.48
There is a small suite of unit tests included in the example. The tests are not exhaustive, only there to prove that existing functionality is unchanged after updates and pull requests. I will not accept any pull requests without adequate unit tests.
Copyright (c) 2012 Ryan Nystrom (http://whoisryannystrom.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.