Big-Data-HPC-Platform/plugins/exampleplugin/README.md

ECL Example Plugin

This is the ECL plugin to utilize the (add plugin name). It utilizes the (Add related API details).

Installation and Dependencies

To build the plugin with the HPCC-Platform, is required.

sudo apt-get install <dependency>

Note: Add notes such as min versions etc.

Getting started

(Add relevant content)

The Actual Plugin

(Add relevant content)

###Sub Section

(Add details)

###An ECL Example

IMPORT example-plugin FROM lib_example-plugin;
IMPORT Wrapper FROM lib_example-plugin;

myWrapper := Wrapper('param1', 'param2');

UNSIGNED4 param3 := 7;
example1 := myWrapper.func1(param3);
example2 := myWrapper.func2('MaKEALLlOWeRCASe');

OUTPUT(example1);
OUTPUT(example2);

Yields the results '8' and 'makealllowercase'

etc etc.

Behaviour and Implementation Details

(Add relevant content)