From f7cd97b4bed877ece3278d2e4f46fdacaa78167b Mon Sep 17 00:00:00 2001 From: joshua bauer Date: Wed, 10 May 2017 07:54:07 -0700 Subject: [PATCH] Updates to README --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 55bddf3..fa3dbb4 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ A great deal of inspiration came from working with the following excellent proje - [Logback](https://logback.qos.ch/) (logging) - [Typesafe Config](https://github.com/typesafehub/config) (config) - [Swagger](http://swagger.io/) (annotations and swagger spec) - - [jax-rs](http://docs.oracle.com/javaee/6/api/javax/ws/rs/package-summary.html) (annotations only) + - [JAX-RS](http://docs.oracle.com/javaee/6/api/javax/ws/rs/package-summary.html) (annotations only) ### Dependencies * [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) @@ -29,8 +29,30 @@ A great deal of inspiration came from working with the following excellent proje - We are very impressed by what Jooby has done with server configuration - 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``` + + - The user adds ```Service``` and ```Module``` classes to the application instance via ```addService``` and ```addModule``` methods prior to calling ```start``` + + ```Java +public class ExampleApplication extends ProteusApplication +{ + public static void main( String[] args ) + { + + ExampleApplication app = new ExampleApplication(); + + app.addService(io.sinistral.proteus.services.SwaggerService.class); + + app.addService(io.sinistral.proteus.services.AssetsService.class); + + app.addController(Benchmarks.class); + + app.start(); + } +} + ``` + ### Getting Started - COMING SOON