From d21930a9d260e559afdc6c16ed99bab6837592b5 Mon Sep 17 00:00:00 2001 From: Hamid <> Date: Sun, 15 May 2022 02:14:27 +0430 Subject: [PATCH] a basic clarence to using the package with composer --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index c000d85..7e92625 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,17 @@ $text = Porter2::stem('consistency'); echo $text; // consist ``` +## Using with Composer package manager +To use this library with Composer, simply run the following command: +``` +composer require markfullmer/porter2 +``` +Then in Your PHP application, simply use the `Porter2` static class with `stem` function: +``` +use markfullmer\Porter2\Porter2; +var_dump(Porter2::stem('consistently')); +``` + ## Stemmer Resources * [Step definition for the Porter 2 stemmer](http://snowball.tartarus.org/algorithms/english/stemmer.html)