From b169d2c6c0612eaf18c7853db512bea452d4a061 Mon Sep 17 00:00:00 2001
From: Philippe Caseiro <pcaseiro@cadoles.com>
Date: Wed, 23 Mar 2022 13:29:06 +0100
Subject: [PATCH] Update readme

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index ea6bc67..a8b5159 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,31 @@ Very simple ninebadge shell client
 # Depends
 
 This works with "curlie" (https://curlie.io)
+
+# HowTo
+
+## Configuration
+Create a ".bagdyrc" file with this lines :
+
+```
+BADGEURL=https://badge.cadoles.com/ninebadge/rest
+KEY=XXXXXX-XXX-XXX-XXX-XXX
+```
+
+You can find you key in your user profile from ninebadge.
+
+## Clockin
+
+$ badgy in
+
+## Clockout
+
+$ badgy out
+
+## Validate the "current" day
+
+$ badgy val
+
+## Show your current status (captial time and clocks)
+
+$ badgy show