From e131c968526528b51f76df3bc0b8537febc65b44 Mon Sep 17 00:00:00 2001 From: noboomu Date: Wed, 9 Jan 2019 15:41:40 -0800 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 528aacb..eb36c4d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ An extremely __lightweight, flexible, and high performance__ [Undertow](http://undertow.io) based Java framework for developing RESTful web applications and microservices. - __NO MAGIC__ -- Lightweight: limited dependencies and < 340kb +- Incredibly easy to use and get started +- Limited dependencies and < 340kb - JAX-RS compliant - Easy on the developer and the metal - Blazing fast!!! @@ -157,7 +158,7 @@ If the response object's `contentType` is not explicitly set, the `@Produces` an For methods that should return a `String` or `ByteBuffer` to the client users can create responses like this: ```java ... - import static io.sinistral.proteus.server.ServerResponse.response; + import static io.sinistral.proteus.server.ServerResponse.response; ... @GET @Path("/hello-world") @@ -173,8 +174,9 @@ By default, passing a `String` to the static `ServerResponse.response` helper fu For other types of responses the following demonstrates the preferred style: ```java ... - import static io.sinistral.proteus.server.ServerResponse.response; - ... + + import static io.sinistral.proteus.server.ServerResponse.response; + ... @GET @Path("/world") @Produces((MediaType.APPLICATION_JSON)) @@ -189,7 +191,8 @@ The entity can be set separately as well: ```java ... - import static io.sinistral.proteus.server.ServerResponse.response; + + import static io.sinistral.proteus.server.ServerResponse.response; ... @GET @Path("/world") @@ -204,8 +207,8 @@ public ServerResponse getWorld(Integer id, Integer randomNumber ) `CompletableFuture>` can also be used as a response type: ```java - ... - import static io.sinistral.proteus.server.ServerResponse.response; + ... + import static io.sinistral.proteus.server.ServerResponse.response; ... @GET @Path("/future/user") @@ -220,7 +223,7 @@ In this case a handler will be generated with the following source code: ```java ... - import static io.sinistral.proteus.server.ServerResponse.response; + import static io.sinistral.proteus.server.ServerResponse.response; ... public void handleRequest(final io.undertow.server.HttpServerExchange exchange) throws java.lang.Exception { CompletableFuture> response = examplesController.futureUser(); @@ -537,4 +540,4 @@ Built With - [Swagger](http://swagger.io/) (annotations and swagger spec) - [JAX-RS](http://docs.oracle.com/javaee/6/api/javax/ws/rs/package-summary.html) (annotations only) - + \ No newline at end of file