Diff
1diff --git a/plugins/emoji/emoji.plugin.zsh b/plugins/emoji/emoji.plugin.zsh
2index dbaf2bb9e2dd949f81ad55657bc70d946580802d..a98d0b714c4794bc9a7744108b2a66066bcc3fe2 100644
3--- a/plugins/emoji/emoji.plugin.zsh
4+++ b/plugins/emoji/emoji.plugin.zsh
5@@ -2,71 +2,7 @@
6 #
7 # Makes emoji support available within ZSH
8 #
9-# This plugin provides support for working with emoji characters in zsh using human-readable
10-# identifiers. It provides global variables which map emoji names to the actual
11-# characters, and some anmed groupings of emoji. It also provides associated functions
12-# for displaying them.
13-#
14-# Global variables:
15-# $emoji - Maps emoji names to characters
16-# $emoji2 - Auxiliary and combining characters
17-# $emoji_flags - Maps country names to flag characters (using region-indicators)
18-# $emoji_skintone - Skin tone modifiers (from Unicode 8.0)
19-# $emoji_groups - Named groups of emoji. Keys are group names; values are whitespace-separated
20-# lists of character names
21-#
22-# Functions:
23-# random_emoji - Prints a random emoji character
24-# display_emoji - Displays emoji, along with their names
25-#
26-# The emoji names and codes are sourced from Unicode Technical Report #51, which provides
27-# information on emoji support in Unicode. It can be found at http://www.unicode.org/reports/tr51/index.html.
28-#
29-# The group definitions are added by this OMZ plugin. They are not based on external definitions.
30-#
31-# The emoji in the main $emoji map are standalone character sequences which can all be output on their
32-# own, without worrying about combining effects. The values may actually be multi-code-point sequences,
33-# instead of a single code point, and may include combining characters in those sequences. But they're
34-# arranged so their effects do not extend beyond that sequence.
35-#
36-# Usage and Examples:
37-#
38-# To output a specific emoji, use:
39-# $> echo $emoji[<name>]
40-# E.g.:
41-# $> echo $emoji[mouse_face]
42-#
43-# To output a random emoji, use:
44-# $> random_emoji
45-# To output a random emoji from a particular group, use:
46-# $> random_emoji <group>
47-# E.g.:
48-# $> random_emoji fruits
49-# $> random_emoji animals
50-# $> random_emoji vehicles
51-# $> random_emoji faces
52-# The valid group names can be found with `echo ${(k)emoji_groups}`
53-#
54-# To list all available emoji with their names, use:
55-# $> display_emoji
56-# $> display_emoji fruits
57-# $> display_emoji animals
58-# $> display_emoji vehicles
59-# $> display_emoji faces
60-#
61-# To use emoji in a prompt:
62-# PROMPT="$emoji[penguin] > ""
63-# PROMPT='$(random_emoji fruits) > '
64-# surfer=$emoji[surfer]
65-# PROMPT="$surfer > "
66-#
67-#
68-# TODO: Move doco to a README
69-# TODO: Factor out parsing from generation in update_emoji.pl
70-# TODO: Incorporate CLDR data for ordering and groupings
71-# TODO: Short :bracket: style names (from gemoji)
72-# TODO: Country codes for flags
73-# TODO: ZWJ combining function?
74+# See the README for documentation.
75
76 _omz_emoji_plugin_dir="${0:h}"
77