From 13b5489092041353b5ca21fb98e3d2fab1b133c6 Mon Sep 17 00:00:00 2001
From: fabolous005 <fabolous.e05@gmail.com>
Date: Sun, 15 Sep 2024 19:47:03 +0200
Subject: [PATCH] update README

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0543e9a..280f08d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
 # etools
 
-bash library for gentoo utils
\ No newline at end of file
+bash library for gentoo utils
+
+## How to use
+
+`. etools`
+
+## Configuration
+
+etools searches for a configuration file at the following locations:
+`/etc/etools/etools.conf`
+`$HOME/.config/etools.conf`
+`$HOME/.config/etools/etools.conf`
+
+## What it does
+
+provided function are the following:
+`einfo <info>`
+`ewarn <warning>`
+`eerror <error>`
+`etools_configure`
+`etools_unset`
+`etools_smart_find <package name> [repo]`
+