Skip to content

Commit

Permalink
Polished README
Browse files Browse the repository at this point in the history
  • Loading branch information
weavejester committed Feb 12, 2014
1 parent e6e2e1e commit b9424b0
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions README.md
@@ -1,27 +1,30 @@
# snowball-stemmer
# Snowball-Stemmer

Provides a simple wrapper around the tartarus.org Snowball stemmer.
Provides a simple wrapper around the tartarus.org Snowball stemmer.

## Usage
## Installation

After you install it to your maven repo, you can
add it to your `project.clj`
To install, add the following to your project `:dependencies`:

[snowball-stemmer "0.1.0"]

and then, you can use it in the `lein repl`

## Usage

user=> (require '[stemmer.snowball :as sn])
user=> ((sn/stemmer :english) "mice")
"mice"
user=> ((sn/stemmer :english) "mices")
"mice"
user=> ((sn/stemmer :english) "turtles")
"turtl"
user=> ((sn/stemmer :english) "turtle")
"turtl"
```clojure
user=> (require '[stemmer.snowball :as sn])
user=> ((sn/stemmer :english) "mice")
"mice"
user=> ((sn/stemmer :english) "mices")
"mice"
user=> ((sn/stemmer :english) "turtles")
"turtl"
user=> ((sn/stemmer :english) "turtle")
"turtl"
```

## License

Distributed under the Eclipse Public License, the same as Clojure.
Copyright © 2014 James Reeves

Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.

0 comments on commit b9424b0

Please sign in to comment.