summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md24
1 files changed, 14 insertions, 10 deletions
diff --git a/README.md b/README.md
index 6c6f696..4b89dc2 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,19 @@
-# g
-yes, that's the name of it. \
+<img width="565" height="200" alt="g_repo-banner_565x200px" src="https://github.com/user-attachments/assets/e00173a7-23dd-464a-92aa-60fd034bc5c3" />
+
+# g — that's a short name.
`g` is a simple `git` wrapper that you can use if \
you are as lazy as me and do not want write looong \
boooooooring commands like `git commit -a -m "fuck"`.
-#### why "permissive"?
-`g`'s whole logic is to be "permissive" with its \
-syntax so that it is fail-free, and also SHORT.
+### why "permissive"?
+`g`'s whole logic is to be "permissive" with its syntax making it \
+is fail-free, and also **very very** forgiving with its user.
+### but what does it mean _practically_?
+it means that you can write commands **however you like**, _within limitations_. \
+for example, all of these are valid commands to say "`git commit -a -m "hi"`"
+* `g c a m "hi"`
+* `g com a msg "hi"`
+<!-- * `g cam "hi"` // commented out because i am not unsure if i will implement this -->
## get `g`
-~~to get `g` you can either build it yourself or you~~ \
-~~can install the AUR package `getg`.~~
-_note: you still technically cannot get `g` from the AUR_ \
-_because development is still ongoing and no AUR repo was_ \
-_created for it at the moment, please wait a bit :)_
+to get `g` you can either build it yourself or you \
+can install the AUR package `getg`.