diff --git a/README.md b/README.md index eae7ea6aa61c874562e81bc53210e37bbc887ab0..92b7067888d8d234cfae0dbc3541872d9645b0c3 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,16 @@ To run the server API at port 8080: > stack exec javawlp -- -p 8080 --runServer ``` -To query the server (see [API.md](https://git.science.uu.nl/impresshs/javawlp/blob/master/API.md) for available options): +To query the server (see for available options): ``` -> curl localhost:8080/compare?a="examples/Main.java:real1"&b="examples/Main.java:real2" +> curl -X POST -d <json_object> <server_url>:8080/compare ``` +To get the API docs from the server: +- Markdown: Visit `<server_url>:8080/docs` +- Swagger: Visit ``<server_url>:8080/api-swagger` +- [API.md](https://git.science.uu.nl/impresshs/javawlp/blob/master/API.md) + To run the tests: ``` > stack test