initial

README.md

@@ -1,3 +1,65 @@
-# rock
+# 🎸 Rock 🤘
+
+A minimal zsh plugin manager.
+
+Inspired by:
+zcomet - https://github.com/agkozak/zcomet  
+zap - https://github.com/zap-zsh/zap  
+
+
+## Install
+
+```sh
+sh <(curl -s https://git.lucasf.dev/public/rock/raw/branch/master/install.sh)
+```
+
+## Basic plugins
+
+Add the following to your `.zshrc`
+
+```sh
+# Basic Options for zsh configuration.
+plug "https://git.lucasf.dev/public/zsh-basics.git"
+
+plug "zsh-users/zsh-autosuggestions"
+plug "zsh-users/zsh-syntax-highlighting"
+
+# A simple prompt theme
+plug "https://git.lucasf.dev/public/zsh-prompt.git"
+```
+
+## Commands
+
+- To update plugins or Rock itself:
+
+```sh
+rock --update
+```
+
+- To cleanup plugins you are no longer using:
+
+```sh
+rock --clean
+```
+
+- To uninstall Rock:
+
+```sh
+rock --remove
+```
+
+## Notes
+
+By default the manager will try to source plugins that the file name is the same as the repository, with the following extensions:
+
+ - `.plugin.zsh`
+ - `.zsh`
+ - `.zsh-theme`
+
+
+To add some plugin that are named different from the repo name, you need to pass the file name as a parameter as in the example below:
+
+```sh
+plug "spaceship-prompt/spaceship-prompt" spaceship.zsh
+```
 
-A minimal zsh plugin manager.