710a3d5a1e2888a4dfb1769f8f1edd8a590eee22

Author
Kirill <30822663+KirillDemtchenko@users.noreply.github.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

emotty: add README (#8240)

Diff

 1diff --git a/plugins/emotty/README.md b/plugins/emotty/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..2cfbe120cb49aa3eb8b45c74a065f7f62b8fde6d
 4--- /dev/null
 5+++ b/plugins/emotty/README.md
 6@@ -0,0 +1,39 @@
 7+# emotty plugin
 8+
 9+This plugin returns an emoji for the current $TTY number so it can be used
10+in a prompt.
11+
12+To use it, add emotty to the plugins array in your zshrc file:
13+```
14+plugins=(... emotty)
15+```
16+
17+**NOTE:** it requires the [emoji plugin](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/emoji).
18+
19+## Usage
20+
21+The function `emotty` displays an emoji from the current character set (default: `emoji`), based
22+on the number associated to the `$TTY`.
23+
24+There are different sets of emoji characters available, to choose a different
25+set, set `$emotty_set` to the name of the set you would like to use, e.g.:
26+```
27+emotty_set=nature
28+```
29+
30+### Character Sets
31+
32+- emoji
33+- loral
34+- love
35+- nature
36+- stellar
37+- zodiac
38+
39+Use the `display_emotty` function to list the emojis in the current character set, or
40+the character set passed as the first argument. For example:
41+
42+```
43+$ display_emotty zodiac
44+<list of all the emojis in the zodiac character set>
45+```