Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
oubiwann committed Oct 15, 2018
1 parent 67a4834 commit 3c64f82
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Clj-WordNet [![Build Status](https://secure.travis-ci.org/clojusc/wordnet.png)](http://travis-ci.org/clojusc/wordnet)
# Clojure WordNet
[![Build Status](https://secure.travis-ci.org/clojusc/wordnet.png)](http://travis-ci.org/clojusc/wordnet)

A thin/partial wrapper around some [JWI](http://projects.csail.mit.edu/jwi/)
functionality, for interfacing the [WordNet](http://wordnet.princeton.edu/)
Expand All @@ -23,7 +24,7 @@ There is an initial version hosted at [Clojars](https://clojars.org/clojusc/word
For leiningen include a dependency:

```clojure
[clojusc/wordnet "0.4.0"]
[clojusc/wordnet "1.0.0"]
```

For maven-based projects, add the following to your `pom.xml`:
Expand All @@ -32,12 +33,10 @@ For maven-based projects, add the following to your `pom.xml`:
<dependency>
<groupId>clojusc</groupId>
<artifactId>wordnet</artifactId>
<version>0.4.0</version>
<version>1.0.0</version>
</dependency>
```

A snapshot version is also available, use ```"0.1.1-SNAPSHOT"```.

## WordNet Database

The WordNet database is not bundled in this project; it is _referenced_
Expand All @@ -48,7 +47,7 @@ instructions above.
## Quick Examples

```clojure
(require '[clj-wordnet.core :as wordnet])
(require '[wordnet.core :as wordnet])
(def dict (wordnet/make-dictionary "../path-to/wordnet/dict/"))

(def dog (first (dict "dog" :noun)))
Expand Down

0 comments on commit 3c64f82

Please sign in to comment.