From 158d9d21208afe1e3420ab3e0bbd4852cdea5a58 Mon Sep 17 00:00:00 2001
From: terminaldweller <thabogre@gmail.com>
Date: Tue, 12 Jul 2022 18:21:32 +0430
Subject: added a README, fixed a typo, was printing hsl instead of hsi.

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index a7c051b..1e61425 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,25 @@
-# colo
\ No newline at end of file
+# colo
+
+A simple script that prints out the 256 terminal colors in different formats:</br>
+It can print the numbers, the hex value, rgb,hsi and the ansi escape sequence.</br>
+
+```sh
+colo --help
+usage: colo [-h] [--ansi] [--hsi] [--rgb] [--number] [--name] [--hex]
+
+optional arguments:
+  -h, --help  show this help message and exit
+  --ansi      bool
+  --hsi       bool
+  --rgb       bool
+  --number    bool
+  --name      bool
+  --hex       bool
+```
+
+![Image](./img/ansi.png)
+
+## How to get
+```sh
+pip3 install colo
+```
-- 
cgit v1.2.3