Skip to content

Commit

Permalink
Documentation formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
noboomu committed May 19, 2017
1 parent 54420f8 commit d34a467
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@
* A great deal of inspiration came from working with the following excellent projects: [Play](http://playframework.com), [Jooby](http://jooby.org), and [light-4j](https://github.com/networknt/light-4j).

## Motivation
---

* Several years of working with the [Play](http://playframework.com) framework convinced us there had to be a better way.
* We faced a Goldilocks Crisis with the existing alternatives: [Jooby](http://jooby.org) did too much, [light-4j](https://github.com/networknt/light-4j) didn't do quite enough.
* We needed a framework that enabled us to write clean MVC REST controllers that created Swagger docs we could plug directly into the existing [codegen](https://github.com/swagger-api/swagger-codegen) solutions.
* We needed a framework with minimal overhead and performance at or near that of raw [Undertow](http://undertow.io).

## Under the Hood
---

Proteus takes your MVC controller classes and methods decorated with Swagger / JAX-RS annotations and generates native Undertow handler classes at runtime. You can review the generated code by setting the ```io.sinistral.proteus.server``` log level to `DEBUG`.

## Setup
---

Parameters are all configured in the `conf/application.conf` file.
Proteus applications generally have a main method that creates an instance of `io.sinistral.proteus.ProteusApplication`.
Prior to calling `start` on the `ProteusApplication` instance:
Expand Down Expand Up @@ -91,7 +91,6 @@ public class Examples


## Controller Classes
---
### Annotations
##### Class
Controller classes respect standard Swagger / JAX-RS annotations:
Expand Down Expand Up @@ -225,7 +224,6 @@ public ServerResponse<Map<String,Object>> complexParameters(
}
```
## Services
---
Proteus comes with two standard services that extend the ```io.sinistral.proteus.services.BaseService``` class.
##### AssetsService
The AssetsService mounts an asset directory at a given path and is configured in your ```application.conf``` file.
Expand Down Expand Up @@ -275,22 +273,20 @@ swagger {
```

## Getting Started
---
COMING SOON

## Examples
---
COMING SOON


### Dependencies
---

* [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* [Maven 3](http://maven.apache.org/)


### Built With
---

- [Undertow](http://undertow.io) (server)
- [Guice](https://github.com/google/guice) (di)
- [Java Runtime Compiler](https://github.com/OpenHFT/Java-Runtime-Compiler) (runtime generated class compilation)
Expand Down

0 comments on commit d34a467

Please sign in to comment.