Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
noboomu authored Dec 20, 2018
1 parent cb9b0d2 commit 71cdf53
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,11 @@

An extremely __lightweight, flexible, and high performance__ [Undertow](http://undertow.io) based Java framework for developing and running microservices.

__NO MAGIC.__

Limited dependencies.

< 400kb.

JAX-RS compliant.

Blazing fast!!!
- __NO MAGIC.__
- Lightweight: limited dependencies and < 400kb
- JAX-RS compliant
- Easy on the developer and the metal
- Blazing fast!!!
[The latest Techempower benchmarks](https://www.techempower.com/benchmarks/) demonstrate Proteus outperforming 99% of all other web frameworks.

![Top 5 in Java Frameworks for Fortunes](https://github.com/noboomu/proteus-example/blob/master/src/main/resources/images/benchmark1.png?raw=true)
Expand All @@ -20,8 +16,9 @@ Blazing fast!!!

TL;DR
---------------
Proteus rewrites your user friendly MVC controller methods into high performance Undertow response handlers at run time.
Easy on the developer and the metal.
- Proteus rewrites your user friendly MVC controller methods into high performance Undertow response handlers at run time.
- The goal is to provide the absolute highest performance while providing a simple and familiar API.
- As developers, we feel a web framework should provide the essentials at minimal cost.

Getting Started
---------------
Expand Down Expand Up @@ -267,6 +264,8 @@ Proteus comes with three standard services that extend the ```io.sinistral.prote

The SwaggerService generates a swagger-spec file from your endpoints and serves a swagger-ui and spec.

The default configuration serves the spec at `{application.path}/swagger.json` and the ui at `${application.path}/swagger`.

The service is configured in your ```application.conf``` file.

The default configuration:
Expand Down Expand Up @@ -300,7 +299,9 @@ Proteus comes with three standard services that extend the ```io.sinistral.prote

- __OpenAPIService__

The OpenAPIService generates an openapi-spec file from your endpoints and serves the spec.
The OpenAPIService generates an openapi-spec file from your endpoints and serves a swagger-ui and spec.

The default configuration serves the spec at `{application.path}/openapi.yaml` and the ui at `${application.path}/openapi`.

The service is configured in your ```application.conf``` file.

Expand Down

0 comments on commit 71cdf53

Please sign in to comment.