README.md in opener-language-identifier-3.0.1 vs README.md in opener-language-identifier-3.0.2

- old
+ new

@@ -11,11 +11,11 @@ ### Confused by some terminology? This software is part of a larger collection of natural language processing tools known as "the OpeNER project". You can find more information about the -project at (the OpeNER portal)[http://opener-project.github.io]. There you can +project at [the OpeNER portal](http://opener-project.github.io). There you can also find references to terms like KAF (an XML standard to represent linguistic annotations in texts), component, cores, scenario's and pipelines. Quick Use Example ----------------- @@ -35,17 +35,16 @@ echo "This is an English text." | language-identifier This will output: -``` +~~~~ <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <KAF xml:lang="en" version="2.1"> - <raw>This is an English text. -</raw> + <raw>This is an English text.</raw> </KAF> -``` +~~~~ If you just want the language code returned add the ```--no-kaf``` option like this echo "This is an English text." | language-identifier --no-kaf @@ -59,18 +58,18 @@ You can launch a language identification webservice by executing: $ language-identifier-server This will launch a mini webserver with the webservice. It defaults to port 9292, -so you can access it at <http://localhost:9292>. +so you can access it at <http://localhost:9292/>. To launch it on a different port provide the `-p [port-number]` option like this: language-identifier-server -p 1234 -It then launches at <http://localhost:1234> +It then launches at <http://localhost:1234/> Documentation on the Webservice is provided by surfing to the urls provided above. For more information on how to launch a webservice run the command with the ```-h``` option. @@ -84,14 +83,11 @@ Description of dependencies --------------------------- This component runs best if you run it in an environment suited for OpeNER -components. You can find an installation guide and helper tools in the (OpeNER -installer)[https://github.com/opener-project/opener-installer] and (an -installation guide on the Opener -Website)[http://opener-project.github.io/getting-started/how-to/local-installation.html] +components. You can find an installation guide and helper tools in the [OpeNER installer](https://github.com/opener-project/opener-installer) and [an installation guide on the OpenerWebsite](http://opener-project.github.io/getting-started/how-to/local-installation.html) At least you need the following system setup: ### Dependencies for normal use: @@ -117,22 +113,22 @@ actual working component. Where to go from here --------------------- -* Check (the project website)[http://opener-project.github.io] -* (Checkout the webservice)[http://opener.olery.com/language-identifier] +* [Check the project website](http://opener-project.github.io) +* [Checkout the webservice](http://opener.olery.com/language-identifier) Report problem/Get help ----------------------- If you encounter problems, please email support@opener-project.eu or leave an -issue in the (issue tracker)[https://github.com/opener-project/language-identifier/issues]. +issue in the [issue tracker](https://github.com/opener-project/language-identifier/issues). Contributing ------------ -1. Fork it ( http://github.com/opener-project/language-identifier/fork ) +1. Fork it <http://github.com/opener-project/language-identifier/fork> 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request