search

greymatter-io / nifi-sdk

Custom processors, scripts, and templates for using Grey Matter Data with Apache NiFi
Apache License 2.0
4 stars 2 forks source link

Improve readme to give guidance to use of NAR bundle #21

Closed lucasmoten closed 3 years ago

lucasmoten commented 4 years ago

At time of issue filing, the readme is outdated and reflects some guidance intended for developers to build the project. While this information is still useful, it is assumed that most target users will be more interested in how to integrate the resultant NAR file.

We should improve the readme to document that and give priority.

Specifically, refer to the release page, and that to use this with NiFi, users can download the nar file, and that it should be put in the lib folder of their NiFi instance whether that is a bare bones install or a docker setup etc. For docker, consider referencing the volume mount example in the project's docker-compose.yml

lucasmoten commented 3 years ago

The current NAR for NiFi 1.12.1 is nifi-data-nar-1.0.2.nar