50cb0846a9b8216a17fa1e7161ab6562f1dff593

Author
Griko Nibras <grikomsn@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

lol: add README (#7231)


Diff

 1diff --git a/plugins/lol/README.md b/plugins/lol/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..b0e54f57529c8c571e0535224d70bcb2fc9f5c6c
 4--- /dev/null
 5+++ b/plugins/lol/README.md
 6@@ -0,0 +1,83 @@
 7+# lol
 8+
 9+Plugin for adding catspeak aliases, because why not
10+
11+## Enabling the plugin
12+
13+1. Open your `.zshrc` file and add `lol` in the plugins section:
14+
15+   ```zsh
16+   plugins=(
17+       # all your enabled plugins
18+       lol
19+   )
20+   ```
21+
22+2. Reload the source file or restart your Terminal session:
23+
24+   ```console
25+   $ source ~/.zshrc
26+   $
27+   ```
28+
29+## Aliases
30+
31+| Alias        | Command                                                          |
32+| ------------ | ---------------------------------------------------------------- |
33+| `:3`         | `echo`                                                           |
34+| `alwayz`     | `tail -f`                                                        |
35+| `bringz`     | `git pull`                                                       |
36+| `btw`        | `nice`                                                           |
37+| `byes`       | `exit`                                                           |
38+| `chicken`    | `git add`                                                        |
39+| `cya`        | `reboot`                                                         |
40+| `donotwant`  | `rm`                                                             |
41+| `dowant`     | `cp`                                                             |
42+| `gimmeh`     | `touch`                                                          |
43+| `gtfo`       | `mv`                                                             |
44+| `hackzor`    | `git init`                                                       |
45+| `hai`        | `cd`                                                             |
46+| `icanhas`    | `mkdir`                                                          |
47+| `ihasbucket` | `df -h`                                                          |
48+| `iminurbase` | `finger`                                                         |
49+| `inur`       | `locate`                                                         |
50+| `invisible`  | `cat`                                                            |
51+| `iz`         | `ls`                                                             |
52+| `kthxbai`    | `halt`                                                           |
53+| `letcat`     | `git checkout`                                                   |
54+| `moar`       | `more`                                                           |
55+| `nomnom`     | `killall`                                                        |
56+| `nomz`       | `ps aux`                                                         |
57+| `nowai`      | `chmod`                                                          |
58+| `oanward`    | `git commit -m`                                                  |
59+| `obtw`       | `nohup`                                                          |
60+| `onoz`       | `cat /var/log/errors.log`                                        |
61+| `ooanward`   | `git commit -am`                                                 |
62+| `plz`        | `pwd`                                                            |
63+| `pwned`      | `ssh`                                                            |
64+| `rtfm`       | `man`                                                            |
65+| `rulz`       | `git push`                                                       |
66+| `tldr`       | `less`                                                           |
67+| `violenz`    | `git rebase`                                                     |
68+| `visible`    | `echo`                                                           |
69+| `wtf`        | `dmesg`                                                          |
70+| `yolo`       | `git commit -m "$(curl -s https://whatthecommit.com/index.txt)"` |
71+
72+## Usage Examples
73+
74+```sh
75+# mkdir new-directory
76+icanhas new-directory
77+
78+# killall firefox
79+nomnom firefox
80+
81+# chmod u=r,go= some.file
82+nowai u=r,go= some.file
83+
84+# ssh root@catserver.org
85+pwned root@catserver.org
86+
87+# git commit -m "$(curl -s https://whatthecommit.com/index.txt)"
88+yolo
89+```