From b36f874b28a413fcedd863c39ff9888cbcf89128 Mon Sep 17 00:00:00 2001 From: Andreas Heigl Date: Wed, 12 Oct 2016 23:16:29 +0200 Subject: [PATCH] Adds more readme-stuff --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 484c905..3b7482d 100644 --- a/README.md +++ b/README.md @@ -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