some documentation and a license

Author: lloyd

LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2016 Lloyd Hilaiel. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README

@@ -0,0 +1,48 @@
+## An in-memory Go Library for WordNet
+
+This is a go language library for accessing [Princeton's wordnet][].
+
+## Implementation Overview
+
+This library is a native golang parser for wordnet which stores the
+entire thing in RAM.  This approach was taken for faster access times
+because the wordnet database sits in only about 80MB of ram, which is
+not a lot these days.  Parsing the full data files takes around two
+seconds on a modest laptop.
+
+[Princeton's wordnet]: http://wordnet.princeton.edu
+
+## Supported features
+
+* Lookup by term
+* Synonyms
+* All relation types (Antonyms, Hyponyms, Hypernyms, etc)
+* Iteration of the database
+* Lemmatization
+
+## Example Usage
+
+```golang
+import (
+    "log"
+
+    "github.com/lloyd/wnram"
+)
+
+func main() {
+    wn := wnram.New("./path")
+    // lookup "yummy"
+    if found, err := wn.Lookup(Criteria{Matching: "yummy", POS: []PartOfSpeech{Adjective}}); err != nil {
+       log.Fatal("%s", err)
+    } else {
+       // dump details about each matching term to console
+       for _, f := range found {
+           f.Dump()
+       }
+	}
+}
+```
+
+## License
+
+BSD 2 Clause, see `LICENSE`.