From 3e8f3ee120b3038f681cda2de4beece35b5d0989 Mon Sep 17 00:00:00 2001
From: Casual <c@sual.in>
Date: Sat, 11 May 2024 05:04:43 +0300
Subject: [PATCH] readme update

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

diff --git a/README.md b/README.md
index 6bd8372..e7a0661 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
 # Procurator
 
-My Git project manager TUI
+My GoLang project manager/helper TUI 
+
+## Description
+
+It's TUI which automatically run `go mod tidy; go vet` if any file in directory changes and shows result.
+Apart from that, here is regular quick commands like `git add .`, `git push`, `go fmt`...
+
+ 
+### Installation
+
+`go install git.sual.in/casual/procurator@latest`
+
+### Usage
+
+`procurator` in git repo directory 
+
+## TODO
+
+ - add other quick commands 
+ - add VHS gif in readme
+ - check all TODO in code (like `go vet` only on `.go` files change) and write here
+ - clean code
+ - add programming language autodetect
+ - add other programming language support
+ - add support of detecting changes in subfolders (maybe it works)
+ - make quick commands configurable/modular (like in project file with commands) (or presets)