Skip to content

Commit

Permalink
Adds more readme-stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
heiglandreas committed Oct 12, 2016
1 parent 1462067 commit b36f874
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,26 @@

Calculate text-statistics including Sylables, Flesch-Reading-Ease (english and german) and such things.

[![Build Status](https://travis-ci.org/heiglandreas/TextStatistics.svg?branch=master)](https://travis-ci.org/heiglandreas/TextStatistics)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/heiglandreas/TextStatistics/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/heiglandreas/TextStatistics/?branch=master)
[![Code Climate](https://codeclimate.com/github/heiglandreas/TextStatistics/badges/gpa.svg)](https://codeclimate.com/github/heiglandreas/TextStatistics)
[![StyleCI](https://styleci.io/repos/70740411/shield?branch=master)](https://styleci.io/repos/70740411)
[![Coverage Status](https://coveralls.io/repos/github/heiglandreas/TextStatistics/badge.svg?branch=master)](https://coveralls.io/github/heiglandreas/TextStatistics?branch=master)

## Why

The one other implementation [davechild/textstatistics](https://packagist.org/packages/davechild/textstatistics)
sadly only implements statistics for english texts. That sadly didn't work for texts with
f.e. german umlauts. So I decided to implement some of the algorithms again using work I
already did for a [hyphenator](https://packagist.org/packages/org_heigl/hyphenator).

That's why f.e. the syllable-calculation differs.


## Installation

TextStatistics is best installed using [composer](https://getcomposer.org)

## Usage

TBD

0 comments on commit b36f874

Please sign in to comment.