Add WordNet version to README

fix typo

LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2015-2016 Amit Lavon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,12 +1,27 @@
 WordNet in JSON Format
 ======================
 
-Such fun!
+The [WordNet](http://wordnet.princeton.edu) dataset is provided in a format that requires dedicated parsing routines. [JSON](https://en.wikipedia.org/wiki/JSON#Example) is a universal data format, that is supported across various programming languages.
+
+**Using JSON, anyone can import and use WordNet dataset with ease.**
+
+Version
+-------
+
+This dataset was built from version 3.1 of the [WordNet data files](https://wordnet.princeton.edu/download/current-version).
+
+Citation
+--------
+
+This dataset is based on: Princeton University "About WordNet." WordNet.
+Princeton University. 2010. http://wordnet.princeton.edu
+
+Please cite them if you use this dataset.
 
 Download
 --------
 
-[Here](https://dl.dropboxusercontent.com/u/20957649/data/wordnet.json.gz).
+See [releases](https://github.com/fluhus/wordnet-to-json/releases).
 
 File Structure
 --------------
@@ -17,10 +32,13 @@ An entire WordNet database.
 
 Fields:
 
-* **Synset** (map to [Synset](#synset)) from synset ID to synset object.
-* **Lemma** (map to string array) from pos.lemma to synset IDs that contain it.
-* **Exception** (map to string array) from exceptional word to its forms.
-* **Example** (map to string) from example ID to sentence template.
+* **synset** (map to [Synset](#synset)) from synset ID to synset object.
+* **lemma** (map to string array) from pos.lemma to synset IDs that contain it.
+* **lemmaRanked** (map to string array) like Lemma but synsets are ordered from the
+  most frequently used to the least. Only a subset of the synsets are ranked, so
+  LemmaRanked has less synsets.
+* **exception** (map to string array) from exceptional word to its forms.
+* **example** (map to string) from example ID to sentence template.
 
 #### Synset
 
@@ -28,12 +46,18 @@ A set of synonymous words.
 
 Fields:
 
-* **Pos** (string) part of speech - a, n, r, s, v.
-* **Word** (string array) words in this synset
-* **Pointer** ([Pointer](#pointer) array) pointers to other synsets.
-* **Frame** ([Frame](#frame) array) sentence frames for verbs.
-* **Gloss** (string) lexical definition.
-* **Example** ([Example](#example) array) usage examples for words in this synset. Verbs only.
+* **offset** (int) synset offset in the raw data file, also used as an identifier.
+* **pos** (string) part of speech:
+  * a: adjective
+  * n: noun
+  * r: adverb
+  * s: satellite
+  * v: verb
+* **word** (string array) words in this synset.
+* **pointer** ([Pointer](#pointer) array) pointers to other synsets.
+* **frame** ([Frame](#frame) array) sentence frames for verbs.
+* **gloss** (string) lexical definition.
+* **example** ([Example](#example) array) usage examples for words in this synset. Verbs only.
 
 #### Pointer
 
@@ -41,11 +65,11 @@ Denotes a semantic relation between one synset/word to another.
 
 Fields:
 
-* **Symbol** (string) relation between the 2 words. Target is \<symbol\> to source. See their meanings
+* **symbol** (string) relation between the 2 words. Target is \<symbol\> to source. See their meanings
   [here](https://godoc.org/github.com/fluhus/gostuff/nlp/wordnet#pkg-constants).
-* **Synset** (string) target synset ID.
-* **Source** (int) index of word in source synset, -1 for entire synset.
-* **Target** (int) index of word in target synset, -1 for entire synset.
+* **synset** (string) target synset ID.
+* **source** (int) index of word in source synset, -1 for entire synset.
+* **target** (int) index of word in target synset, -1 for entire synset.
 
 #### Frame
 
@@ -53,8 +77,8 @@ Links a synset word to a generic phrase that illustrates how to use it. Applies
 
 Fields:
 
-* **WordNumber** (int) index of word in the containing synset, -1 for entire synset.
-* **FrameNumber** (int) frame number on the WordNet site.
+* **wordNumber** (int) index of word in the containing synset, -1 for entire synset.
+* **frameNumber** (int) frame number on the WordNet site.
 
 #### Example
 
@@ -62,22 +86,20 @@ Links a synset word to an example sentence. Applies to verbs only.
 
 Fields:
 
-* **WordNumber** (int) index of word in the containing synset, -1 for entire synset.
-* **TemplateNumber** (int) tumber of template in the [WordNet](#wordnet).Example field.
+* **wordNumber** (int) index of word in the containing synset, -1 for entire synset.
+* **templateNumber** (int) tumber of template in the [WordNet](#wordnet).Example field.
 
 Go API
 ------
 
 If you are working with Go, I encourage you to skip this JSON file and work
 directly with the [Go API](https://godoc.org/github.com/fluhus/gostuff/nlp/wordnet).
-This JSON dump is simply a serialized
+This JSON dump is simply a marshaled
 [WordNet](https://godoc.org/github.com/fluhus/gostuff/nlp/wordnet#WordNet)
 struct.
 
-Citation
---------
+Having Trouble?
+---------------
 
-This dataset is based on: Princeton University "About WordNet." WordNet.
-Princeton University. 2010. http://wordnet.princeton.edu
-
-Please cite them if you use this dataset.
+If you have any issues, questions, or comments - feel free to share them on the
+[issues](https://github.com/fluhus/wordnet-to-json/issues) section.