summaryrefslogtreecommitdiffstats
path: root/zsh/oh-my-zsh/plugins/emotty/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'zsh/oh-my-zsh/plugins/emotty/README.md')
-rw-r--r--zsh/oh-my-zsh/plugins/emotty/README.md39
1 files changed, 0 insertions, 39 deletions
diff --git a/zsh/oh-my-zsh/plugins/emotty/README.md b/zsh/oh-my-zsh/plugins/emotty/README.md
deleted file mode 100644
index ee57170..0000000
--- a/zsh/oh-my-zsh/plugins/emotty/README.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# emotty plugin
-
-This plugin returns an emoji for the current $TTY number so it can be used
-in a prompt.
-
-To use it, add emotty to the plugins array in your zshrc file:
-```
-plugins=(... emotty)
-```
-
-**NOTE:** it requires the [emoji plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/emoji).
-
-## Usage
-
-The function `emotty` displays an emoji from the current character set (default: `emoji`), based
-on the number associated to the `$TTY`.
-
-There are different sets of emoji characters available, to choose a different
-set, set `$emotty_set` to the name of the set you would like to use, e.g.:
-```
-emotty_set=nature
-```
-
-### Character Sets
-
-- emoji
-- loral
-- love
-- nature
-- stellar
-- zodiac
-
-Use the `display_emotty` function to list the emojis in the current character set, or
-the character set passed as the first argument. For example:
-
-```
-$ display_emotty zodiac
-<list of all the emojis in the zodiac character set>
-```