Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SeunAdelekan authored Jun 5, 2017
1 parent 7fca56a commit d7c34f9
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ For other use cases, you can download jars from bintray
* Availability of action lifecycle callback methods

## Quick start
A breakdown of project packages is [here](##packages).

### Creating a Kanary app and starting a server
A simple Kanary app that listens on a port is created by initializing an istance of KanaryApp, creating a Server object, creating an AppHandler instance, setting that instance as the server's handler and starting the server to listen on a specified port.
```kotlin
Expand Down Expand Up @@ -226,6 +228,15 @@ class UserController : KanaryController() {
}
```

## Packages
| class | package |
| ------ | ------ |
| KanaryApp | com.iyanuadelekan.kanary.app |
| KanaryController | com.iyanuadelekan.kanary.core |
| KanaryRouter | com.iyanuadelekan.kanary.core |
| AppHandler | com.iyanuadelekan.kanary.handlers |
| server | com.iyanuadelekan.kanary.server |

## Dependencies
* [Jetty](http://eclipse.org/jetty) (as an application server engine)
* [Jackson-databind](https://github.com/FasterXML/jackson-databind/blob/master/README.md) (for JSON serialization/deserialization)
Expand Down

0 comments on commit d7c34f9

Please sign in to comment.