Skip to content

Commit

Permalink
Doc updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
noboomu committed May 19, 2017
1 parent d34a467 commit aad78b4
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Proteus takes your MVC controller classes and methods decorated with Swagger / J

## Setup

Parameters are all configured in the `conf/application.conf` file.
By default, the configuration is loaded into a `com.typesafe.config.Config` from a file at `conf/application.conf`.
`@Named` annotated properties of `Module`, `Service` and controller classes are bound to values found in the configuration.

Proteus applications generally have a main method that creates an instance of `io.sinistral.proteus.ProteusApplication`.
Prior to calling `start` on the `ProteusApplication` instance:
* Register `Service` classes via `addService`
Expand All @@ -26,6 +28,9 @@ Prior to calling `start` on the `ProteusApplication` instance:

Out of the box you get a [Swagger UI](https://github.com/swagger-api/swagger-ui) at `/swagger` and [Redoc](https://github.com/Rebilly/ReDoc) at `/swagger/redoc`.

> A `Service` extends `com.google.common.util.concurrent.AbstractIdleService` or `io.sinistral.proteus.servicesBaseService`.
> A `Module` implements `com.google.inject.Module`.
##### Example Application Class

```java
Expand Down

0 comments on commit aad78b4

Please sign in to comment.