Skip to content

Commit

Permalink
Update ReadMe and prep for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
noboomu committed Oct 3, 2018
1 parent c4308a5 commit 22eb491
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 6 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
Expand All @@ -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
<dependency>
<groupId>io.sinistral</groupId>
<artifactId>proteus-core</artifactId>
<version>0.3.4-SNAPSHOT</version>
</dependency>
```

Controllers
---------------
Expand Down Expand Up @@ -177,6 +184,24 @@ public ServerResponse<Map<String,Object>> 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
-------------

Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.sinistral</groupId>
<artifactId>proteus-core</artifactId>
<version>0.3.4-SNAPSHOT</version>
<version>0.3.3-SNAPSHOT</version>
<name>proteus core</name>
<description>Proteus is an extremely light, fast, and flexible Java REST API framework built atop Undertow.</description>
<url>http://github.com/noboomu/proteus</url>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 22eb491

Please sign in to comment.