diff --git a/README.md b/README.md index 818964d..a0c79b8 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,22 @@ The aim of this project to provide a unified access to Hungarian NLP tools. As such it provides wrapper classes and a REST API. Currently the project integrates: -* [`magyarlanc` 3.0](http://www.inf.u-szeged.hu/rgai/magyarlanc) +* [magyarlanc 3.0](http://www.inf.u-szeged.hu/rgai/magyarlanc) * [Szeged NER](http://www.inf.u-szeged.hu/rgai/NER) -# Usage -## REST API +## Usage +### Install Compile: `$ make dependencies install` -Run: `$ make serve` +### REST API -Test: `$ curl -X POST -H "Content-Type: application/json" -d '{ - "text": "Szia." - }' "http://localhost:9090/v1/parse"` +Run the server: `$ make serve` -## Programmatically +Make a call: `$ curl -X POST -H "Content-Type: application/json" -d '{"text": "Szia."}' "http://localhost:9090/v1/parse"` + +### Programmatically ```java import hu.nlp.api.HuNlp; @@ -30,7 +30,8 @@ List sentences = nlp.parse("Ez itt egy példa. Vajon működik?"); # Changelog ## 0.1 -First release containing only magyarlanc. + +First experimental release containing magyarlanc and Szeged NER. # License