Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
nadar authored Mar 26, 2017
1 parent 14bbc83 commit 99b5bd6
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,35 @@

The main purpose of this repo is to unify different stemming components based on its language.

## Installation

This package is distributed over the packagist service for composer. In order to use this package composer must be installed.

```sh
composer require nadar/stemming
```

## Usage

Using the stemmer for your desired language:

```php
<?php
include 'vendor/autoload.php';

$stemmed = \Nadar\Stemming\Stem::word('drinking', 'en');
$stemmed = \Nadar\Stemming\Stem::word('drinking', 'en');

echo $stemmed; // output: "drink"
```

If your provided language could not be found, the original word will be returned.

You can also stem a whole phares:

```php
echo \Nadar\Stemming\Stem::pharese('I am playing drums', 'en');
```

## Librarys Used:

+ German Stemming: https://github.com/arisro/german-stemmer (Copyright (c) 2013 Aris Buzachis (buzachis.aris@gmail.com))
Expand All @@ -33,4 +48,4 @@ in order to psr2 fix your code run:

```php
./vendor/bin/php-cs-fixer fix src/
```
```

0 comments on commit 99b5bd6

Please sign in to comment.