Add README

rubiojr · Dec 5, 2021 · eaa409c · eaa409c
1 parent 88021fe
commit eaa409c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 /eyez
-/docs
+/docz
 /bin
 /.private
 /records.db

diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# eyeZ
+
+HTTP proxy experiment powered by [bubbletea](https://github.com/charmbracelet) and (httransform)[github.com/9seconds/httransform]
+
+## Features
+
+* Terminal UI
+* Database recording (similar to [hyperfox](https://github.com/malfunkt/hyperfox))
+
+## Action shots
+
+![](docs/tui.png)
diff --git a/docs/tui.png b/docs/tui.png