]> git.armaanb.net Git - admone.git/blobdiff - README.md
added logo
[admone.git] / README.md
index 72b1e40d575eb39e36a6a827187e42c97dae4d33..8f84d9c61892ddc1062d558784e839be16c2649e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,17 @@
 # admone
 A tolerable ZSH prompt
 
+![Screenshot](branding/screenshot.png)
+
 ## Installation
-Source this script somewhere in your ZSHRC
-Theoretically works with plugin managers as well although this is untested
+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
 
-## Requirements
-  - No OhMyZSH dependency
-  - Fast to load
+## My design requirements
+  - No dependency on OhMyZSH
+  - Quick to load
   - 2 lines
   - Git intergration
   - Easily extensible
@@ -22,6 +26,6 @@ admonish, remind, prompt; suggest, advise, raise; persuade, urge; warn, caution
 ```
 
 ## License
-Admone is MIT licensed
+Admone is MIT licensed by Armaan Bhojwani
 
 The code is inspired by [palb91's prompt](https://github.com/palb91/dotfiles/blob/master/zsh/conf.d/00_prompt.zsh) and [this gist by romkatv](https://gist.github.com/romkatv/2a107ef9314f0d5f76563725b42f7cab)