From b6a2addbc7bf8ef0661a56cb1ae0184f2242ff21 Mon Sep 17 00:00:00 2001 From: Artus Date: Mon, 13 May 2019 14:41:57 +0200 Subject: [PATCH] updates README --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bdbc26b..70db220 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,17 @@ echo "Script title" | title echo "Author: You" | subtitle ``` -Tasks are represented introduced by the `section` helper. +Tasks are wrapped by the `section`, `output` and `result` helpers. The flow is : 1. Print `section` header 2. Use `output` helpers to display the output you want generated - 3. End your call with `result` + 3. Close your section with `result` ``` echo "Task number One" | section +echo "This will work" | output::info ls -l |& output -echo "Warning" | output::warning +echo "This will not" | output::warning ls /non_existent_file |& output result ```