From 22eb49182491c5177be60d32ee4e6f3b5d5b7cc9 Mon Sep 17 00:00:00 2001 From: joshua bauer Date: Wed, 3 Oct 2018 10:11:16 -0700 Subject: [PATCH] Update ReadMe and prep for release. --- README.md | 33 +++++++++++++++++-- pom.xml | 2 +- .../test/server/TestControllerEndpoints.java | 3 +- 3 files changed, 32 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d495a8d..d2e2725 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,11 @@ JAX-RS compliant. Verifiably [FAST](https://www.techempower.com/benchmarks/): [The latest benchmarks](https://www.techempower.com/benchmarks/) show Proteus outperforming 99% of other web frameworks. -Inspired by [Play](http://playframework.com), [Jooby](http://jooby.org), and [light-4j](https://github.com/networknt/light-4j). - - Getting Started --------------- +### Quick Start - Make sure you have a JDK >= 8 and a current version of Maven installed. - Copy and paste into your terminal: ``` @@ -29,6 +27,15 @@ Getting Started - Open [http://localhost:8090/v1/swagger](http://localhost:8090/v1/swagger) in your browser. - Open [http://localhost:8090/v1/swagger/redoc](http://localhost:8090/v1/swagger/redoc) for a pretty version of your API. +### As a dependency + +```xml + + io.sinistral + proteus-core + 0.3.4-SNAPSHOT + +``` Controllers --------------- @@ -177,6 +184,24 @@ public ServerResponse> complexParameters( return response(responseMap).applicationJson(); } ``` + +Annotations +------------- + +Proteus has three built in annotations: + +* @Blocking + * ```io.sinistral.proteus.annotations.Blocking``` + * Forces the request processing to block. + +* @Debug + * ```io.sinistral.proteus.annotations.Debug``` + * Dumps the request and response details to the log. + +* @Chain + * ```io.sinistral.proteus.annotations.Chain``` + * Wraps the endpoint handler in the provided array of ```io.undertow.server.HttpHandler``` classes. + Services ------------- @@ -269,6 +294,8 @@ Motivation * We needed a framework with minimal overhead and performance at or near that of raw [Undertow](http://undertow.io). +Inspired by [Play](http://playframework.com), [Jooby](http://jooby.org), and [light-4j](https://github.com/networknt/light-4j). + Dependencies ---------- * [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) diff --git a/pom.xml b/pom.xml index a0e4bc6..28a54fa 100644 --- a/pom.xml +++ b/pom.xml @@ -3,7 +3,7 @@ 4.0.0 io.sinistral proteus-core - 0.3.4-SNAPSHOT + 0.3.3-SNAPSHOT proteus core Proteus is an extremely light, fast, and flexible Java REST API framework built atop Undertow. http://github.com/noboomu/proteus diff --git a/src/test/java/io/sinistral/proteus/test/server/TestControllerEndpoints.java b/src/test/java/io/sinistral/proteus/test/server/TestControllerEndpoints.java index 6a7a1fb..eeeba68 100644 --- a/src/test/java/io/sinistral/proteus/test/server/TestControllerEndpoints.java +++ b/src/test/java/io/sinistral/proteus/test/server/TestControllerEndpoints.java @@ -13,8 +13,7 @@ import java.io.File; import java.io.InputStream; import java.nio.file.Files; -import java.util.Arrays; -import java.util.Collections; +import java.util.Arrays; import java.util.HashSet; import java.util.List; import java.util.Map;