From 2861a347aeb83e90b9493cab0e10d2b956471c1f Mon Sep 17 00:00:00 2001 From: Florian Rampp Date: Mon, 11 Mar 2013 07:13:07 +0100 Subject: [PATCH] commented modules --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 24e876c..9616e7e 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,15 @@ Contributing ------------ The project is built with [Gradle](http://www.gradle.org/). Use the commited Gradle wrapper script to obtain Gradle. Type `./gradlew tasks` to get an overview of executable Gradle tasks. The task `distZip` is used to build a ZIP file that can be distributed. +Modules +------- +The jambel control consists of the following five modules: + +1. **config**: loads configuration from a JSON file and hosts the configuration classes for other modules +2. **signallight**: allows controlling a signal light, like configuring blink times, setting individual light statuses, and retrieving the current status; depends on config module +3. **hub**: Contains the logic of retrieving intial job statuses, aggregating multiple job statuses, and using a signal light for displaying the aggregated state; depends on config and signallight modules +4. **server**: Sets up the jambel as a standalone web application using Jetty. Offers a simple web interface and an endpoint for HTTP POSTs of the Jenkins Notification plugin; depends on config and hub modules + Potential extensions --------------------