From ab27adf3c596ba0da67c4a2d38da032ac2e73c09 Mon Sep 17 00:00:00 2001
From: Artus <artus@landoftheunicorn.ovh>
Date: Mon, 13 May 2019 11:58:52 +0200
Subject: [PATCH] updates README

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1ddc751..06ae3a4 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
 # bog
 
-Bash Output Generator
\ No newline at end of file
+Bash Output Generator
+
+## Usage
+
+Anotate your script with formatting helpers by using pipe construct
+
+*Example*
+
+```
+echo "Script title" | title
+echo "Author: You"  | subtitle
+```
+
+Tasks are represented introduced by the `section` helper.
+The flow is :
+  1. Print section header
+  2. Use `output` helpers to display the output you want generated
+  3. End your call with `result`
+
+```
+echo "Task number One" | section
+ls -l		       | output
+echo "Warning"	       | output::warning
+ls /non_existent_file  |& output
+```