README.md template

README.md

MySuperbComponent

Here describe shortly what the component does.

MySuperbComponent component is responsible for multiplication of numbers stored in CDO. It takes two integer numbers and saves the result in the first operand. As it is very early prototype, it supports only small numbers (up to 10).

Requirements

Here describe build requirements such as Java version, build tool (e.g. Maven, SBT) and possibly other dependencies that are neither in PaaSage nor Central Maven repository.

• Java 9
• AnotherFancyBuildTool 10.0
• ...

Building

Here tell us how to build standalone JAR. For components built with Maven it should be as simple as

$ mvn clean compile assembly:single

but still should be described here. Some components are built with another tools like SBT, adjust this instructions respectively.

To build standalone JAR run:

$ mvn clean compile assembly:single

Configuration

Describe how to configure the component.

There are no options specific to the component.

CDO server host and port should be set in $PAASAGE_CONFIG_DIR/eu.paasage.cdo.client.properties similarly to other PaaSage components.

Usage

Here describe what API component provides to the system. First, describe how the API is exposed (e.g. command-line or service with called with AMQP, etc.). Second, describe what are the APIs exposed to the end user (and only those). Please specify what is the input and what is expected result of the operation. If possible, provide corresponding files for both input and output in the repository as a reference.

Component provides CLI interface:

$ java -jar superb-component-assembly-2015.04-SNAPSHOT.jar resourceA resourceB

Input: Two numbers stored in the CDO in resourceA and resourceB

Output: resourceA is updated with result of the multiplication.

Helper modules

If component has any helper tools (e.g. for development and debugging) embeded, please describe it here.

In addition to it's main function it also provides debugging/helper tools described below.

CDO-less interface

It is possible to multiply numbers supplied to commandline without involving CDO. The result is printed to the stdout.

$ java -cp superb-component-assembly-2015.04-SNAPSHOT.jar eu.paasage.mock.multiply.Cli 5 4
20

Limitations

Add this section if required.

• Only small numbers (up to 10) can be multiplied.
• Negative numbers are not supported.