lol: add README (#7231)

8 years ago · 50cb0846a9
parent 0963a9a4cc
commit 50cb0846a9
1 changed files with 83 additions and 0 deletions
--- a/plugins/lol/README.md
+++ b/plugins/lol/README.md
@ -0,0 +1,83 @@
+# lol
+
+Plugin for adding catspeak aliases, because why not
+
+## Enabling the plugin
+
+1. Open your `.zshrc` file and add `lol` in the plugins section:
+
+   ```zsh
+   plugins=(
+       # all your enabled plugins
+       lol
+   )
+   ```
+
+2. Reload the source file or restart your Terminal session:
+
+   ```console
+   $ source ~/.zshrc
+   $
+   ```
+
+## Aliases
+
+| Alias        | Command                                                          |
+| ------------ | ---------------------------------------------------------------- |
+| `:3`         | `echo`                                                           |
+| `alwayz`     | `tail -f`                                                        |
+| `bringz`     | `git pull`                                                       |
+| `btw`        | `nice`                                                           |
+| `byes`       | `exit`                                                           |
+| `chicken`    | `git add`                                                        |
+| `cya`        | `reboot`                                                         |
+| `donotwant`  | `rm`                                                             |
+| `dowant`     | `cp`                                                             |
+| `gimmeh`     | `touch`                                                          |
+| `gtfo`       | `mv`                                                             |
+| `hackzor`    | `git init`                                                       |
+| `hai`        | `cd`                                                             |
+| `icanhas`    | `mkdir`                                                          |
+| `ihasbucket` | `df -h`                                                          |
+| `iminurbase` | `finger`                                                         |
+| `inur`       | `locate`                                                         |
+| `invisible`  | `cat`                                                            |
+| `iz`         | `ls`                                                             |
+| `kthxbai`    | `halt`                                                           |
+| `letcat`     | `git checkout`                                                   |
+| `moar`       | `more`                                                           |
+| `nomnom`     | `killall`                                                        |
+| `nomz`       | `ps aux`                                                         |
+| `nowai`      | `chmod`                                                          |
+| `oanward`    | `git commit -m`                                                  |
+| `obtw`       | `nohup`                                                          |
+| `onoz`       | `cat /var/log/errors.log`                                        |
+| `ooanward`   | `git commit -am`                                                 |
+| `plz`        | `pwd`                                                            |
+| `pwned`      | `ssh`                                                            |
+| `rtfm`       | `man`                                                            |
+| `rulz`       | `git push`                                                       |
+| `tldr`       | `less`                                                           |
+| `violenz`    | `git rebase`                                                     |
+| `visible`    | `echo`                                                           |
+| `wtf`        | `dmesg`                                                          |
+| `yolo`       | `git commit -m "$(curl -s https://whatthecommit.com/index.txt)"` |
+
+## Usage Examples
+
+```sh
+# mkdir new-directory
+icanhas new-directory
+
+# killall firefox
+nomnom firefox
+
+# chmod u=r,go= some.file
+nowai u=r,go= some.file
+
+# ssh root@catserver.org
+pwned root@catserver.org
+
+# git commit -m "$(curl -s https://whatthecommit.com/index.txt)"
+yolo
+```