improved docs

Author: hauner

README.md

@@ -1,12 +1,24 @@
-# openapi-processor-spring sample project
+# openapi-processor-spring (mvc) sample project
 
-This is a simple Spring Boot project that is using 
+This is a simple Spring Boot (gradle) project that is using 
 * [openapi-processor-spring][oap-spring] to
-generate java interfaces for the api defined in an openapi.yaml file and
-* the [openapi-processor-json][oap-json] to convert the openapi yaml to json format. 
+generate java interfaces for the api defined in an openapi.yaml file
+* the [openapi-processor-json][oap-json] to convert the openapi yaml to json format
+* and the [openapi-processor-gradle plugin][oap-gradle] to run both processors.
 
+The purpose of the sample is to show the setup of the gradle plugin and the processors.
 
-The sample is based on gradle and uses the [openapi-processor-gradle plugin][oap-gradle].
+## Endpoints
+
+the sample has a few simple endpoints described with OpenAPI in `src/api`. 
+
+### ping
+
+    curl http://localhost:8080/ping 
+
+### echo
+
+    curl http://localhost:8080/echo?source=foo 
 
 [oap-spring]: https://hauner.github.io/openapi-processor-spring/
 [oap-json]: https://hauner.github.io/openapi-processor-json/