bash/bog
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updates README

Browse Source
This commit is contained in:
Arthur Gerbaud
2019-05-13 14:41:57 +02:00
parent d33db3e267
commit b6a2addbc7
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -13,16 +13,17 @@ echo "Script title" | title
echo "Author: You" | subtitle 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 : The flow is :
1. Print `section` header 1. Print `section` header
2. Use `output` helpers to display the output you want generated 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 "Task number One" | section
echo "This will work" | output::info
ls -l |& output ls -l |& output
echo "Warning" | output::warning echo "This will not" | output::warning
ls /non_existent_file |& output ls /non_existent_file |& output
result result
``` ```