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 ` +`ewarn ` +`eerror ` +`etools_configure` +`etools_unset` +`etools_smart_find [repo]` +