commit b378da44608e9b038897b904ca518d91fba14cbc
parent 746dcc16770864e465b33b62319d38d8fa4e9132
Author: Iqbal Ansari <iqbalansari02@yahoo.com>
Date: Sun, 4 Sep 2016 18:00:20 +0530
Mention the new command `emojify-insert-emoji` in the README
Diffstat:
1 file changed, 18 insertions(+), 9 deletions(-)
diff --git a/README.org b/README.org
@@ -10,6 +10,8 @@
- [[#installation][Installation]]
- [[#elpa][ELPA]]
- [[#usage][Usage]]
+ - [[#displaying-emojis][Displaying emojis]]
+ - [[#inserting-emojis][Inserting emojis]]
- [[#customizations][Customizations]]
- [[#configuring-the-types-of-emojis-displayed][Configuring the types of emojis displayed]]
- [[#configuring-how-emojis-are-displayed][Configuring how emojis are displayed]]
@@ -63,18 +65,25 @@
#+END_QUOTE
** Usage
- ~emojify-mode~ can be enabled/disabled separately for a buffer by using the
- command ~emojify-mode~, to enable/disable it globally use the command
- ~global-emojify-mode~.
+*** Displaying emojis
+ ~emojify-mode~ can be enabled/disabled separately for a buffer by using the
+ command ~emojify-mode~, to enable/disable it globally use the command
+ ~global-emojify-mode~.
- To enable ~emojify-mode~ globally at startup add something like the following
- to your ~init~ file
+ To enable ~emojify-mode~ globally at startup add something like the
+ following to your ~init~ file
- #+BEGIN_SRC emacs-lisp
- (add-hook 'after-init-hook #'global-emojify-mode)
- #+END_SRC
+ #+BEGIN_SRC emacs-lisp
+ (add-hook 'after-init-hook #'global-emojify-mode)
+ #+END_SRC
+
+ In programming modes only emojis in string and comments are displayed.
- In programming modes only emojis in string and comments are displayed.
+*** Inserting emojis
+ The command ~emojify-insert-emoji~ can be used to insert emojis
+ interactively. While the command works with vanilla Emacs completion system,
+ the experience would be better with something like [[https://github.com/emacs-helm/helm][Helm]], [[https://github.com/abo-abo/swiper][Ivy]] or Ido
+ depending on you preference.
** Customizations
*** Configuring the types of emojis displayed