Browse Source

added readme

Grega Bremec 3 years ago
parent
commit
fdf9ed68d1
3 changed files with 53 additions and 2 deletions
  1. 5 0
      .gitignore
  2. 31 0
      COPYING
  3. 17 2
      readme.md

+ 5 - 0
.gitignore

@@ -0,0 +1,5 @@
+.project
+.classpath
+.settings
+.*.swp
+target

+ 31 - 0
COPYING

@@ -0,0 +1,31 @@
+This software is being published under terms and conditions set forth
+by the BSD License.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of P0F.NET nor the names of contributors may
+      be used to endorse or promote products derived from this
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

+ 17 - 2
readme.md

@@ -1,6 +1,21 @@
 Simple "Hello" Process
 =======================
 
-This simple project contains just one process model that is used in the
-```kie-rules-processes``` project example of
+This simple process contains just one simple script task that greets the person
+contained within the ```Customer``` object passed as the process parameter.
+
+It is used in the ```kie-rules-processes``` project example of
 ```net.p0f.samples.rhpam_fuse_integration.UseRemoteKieArtifact```.
+
+Start-Stop-Start Process
+========================
+
+This process model starts up, prints a message on STDOUT (for debugging
+purposes) and then waits at an intermediate signal catch task to be woken up by
+a signal called "ReleaseMe", which only expects a string parameter. It then
+prints the content of signal payload on STDOUT again, and ends.
+
+Used in some examples from the ```consume-rhpam-rest-api``` project, package
+```net.p0f.samples.rhpam_fuse_integration.rest_client```, but also in the Camel
+examples from the SpringBoot and Quarkus projects.
+