README.md in open-nlp-0.0.1 vs README.md in open-nlp-0.1.0
- old
+ new
@@ -1,23 +1,20 @@
-**Warning**
+[](http://travis-ci.org/louismullie/open-nlp)
-This is an alpha release. Expect things to break and/or change in the near future! Also, keep the following in mind:
-
-- Currently, this gem is only tested on JRuby, but support for MRI through Rjb is coming very soon.
-- Currently, the parser and chunker classes are not working.
-
**About**
This library provides high-level Ruby bindings to the Open NLP package, a Java machine learning toolkit for natural language processing (NLP).
This gem only provides a thin wrapper over the OpenNLP API. If you are looking for a Ruby natural language processing framework, have a look at [Treat](https://github.com/louismullie/treat).
**Installing**
+_Note: If you are running on MRI, this gem will use the Ruby-Java Bridge (Rjb), which currently does not support Java 7. Therefore, if you have installed Java 7, you should set your JAVA_HOME to point to your old Java 6 install before installing Rjb; for example, `export "JAVA_HOME=/usr/lib/jvm/java-6-openjdk/"`.
+
First, install the gem: `gem install open-nlp`. Then, individually download the appropriate models from the [open-nlp website](http://opennlp.sourceforge.net/models-1.5/) or just get [all english language models](louismullie.com/treat/open-nlp-english.zip) in one package (80 MB).
-Place the contents of the extracted archive inside the /bin/ folder of the stanford-core-nlp gem (e.g. [...]/gems/open-nlp-0.x.x/bin/).
+Place the contents of the extracted archive inside the /bin/ folder of the open-nlp gem (e.g. [...]/gems/open-nlp-0.x.x/bin/).
**Configuration**
After installing and requiring the gem (`require 'open-nlp'`), you may want to set some optional configuration options. Here are some examples:
@@ -41,10 +38,10 @@
# Use the model files for a different language than English.
# OpenNLP.use(:french) # or :german
#
# Change a specific model file.
-# StanfordCoreNLP.set_model('pos.model', 'english-left3words-distsim.tagger')
+# OpenNLP.set_model('pos.model', 'english-left3words-distsim.tagger')
```
**Using the gem**
```ruby
\ No newline at end of file