init

1 files changed, 16 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..bb21131
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,16 @@
+## gentoo portage overlay stealer
+
+a utility to make your system cleaner:3
+
+
+all you need to do is [create an ebuild repository](https://wiki.gentoo.org/wiki/Creating_an_ebuild_repository), and modify example_config.yaml (and move it to ~/.config/gpo-steal/config.yaml)
+
+run with no commands for help
+
+---
+
+you can either run `./src/__main__.py`
+
+or zip the source directory, and run `python <name>.zip`
+
+