Combine VCS and PWD

[admone.git] / README.md

diff --git a/README.md b/README.md
index 2be7c82fdf142f762387ac813f60d6267ad633ed..e56168ebc4e98af799927283d6314ba42e2717a8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
 # admone
+A tolerable Zsh prompt
 
-A tolerable ZSH prompt
\ No newline at end of file
+## Installation
+Source this script somewhere in your Zshrc. Theoretically works with plugin managers as well, although this is untested
+
+## Configuration
+Configuration is done by modifying the variables set at the start of the script. Just get in there and mess around a bit, its not very difficult to understand
+
+## My design requirements
+  - No dependency on OhMyZSH
+  - Quick to load
+  - Git integration
+  - Easily extensible
+  - Bracketed sections
+  - Vi-mode integration
+
+## Name
+```
+admon.e              V      2 1 PRES ACTIVE  IMP 2 S    
+admoneo, admonere, admonui, admonitus  V (2nd) TRANS   [XXXAO]  
+admonish, remind, prompt; suggest, advise, raise; persuade, urge; warn, caution
+```
+
+## License
+Admone is MIT licensed by [Armaan Bhojwani](https://armaanb.net), 2021.