[elpa] master 5df6abf 12/78: company-tng: Usage instructions

[Dmitry Gutov]

branch: master
commit 5df6abf610acfccfb7c033f082158849c29c8ee8
Author: Nikita Leshenko <address@hidden>
Commit: Nikita Leshenko <address@hidden>

    company-tng: Usage instructions
---
 company-tng.el | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/company-tng.el b/company-tng.el
index ab22924..48d8e4f 100644
--- a/company-tng.el
+++ b/company-tng.el
@@ -35,6 +35,28 @@
 ;;
 ;; The benefits are that there is only one shortcut key to interact
 ;; with and there is no need to confirm an entry.
+;;
+;; Usage:
+;;
+;; To apply the default configuration for company-tng call
+;; `company-tng-configure-default' from your configuration file.
+;;
+;; You can also configure company-tng manually:
+;;
+;; Add `company-tng-frontend' to `company-frontends':
+;; (add-to-list 'company-frontends 'company-tng-frontend)
+;;
+;; We recommend to bind TAB to `company-select-next', S-TAB to
+;; `company-select-previous', and unbind RET and other now-unnecessary
+;; keys from `company-active-map':
+;; (define-key company-active-map (kbd "TAB") 'company-select-next)
+;; (define-key company-active-map (kbd "<backtab>") 'company-select-previous)
+;; (define-key company-active-map (kbd "RET") nil)
+;; Note that it's not necessary to rebind keys to use this frontend,
+;; you can use the arrow keys or M-n/M-p to select and insert
+;; candidates. You also need to decide which keys to unbind, depending
+;; on whether you want them to do the Company action or the default
+;; Emacs action (for example C-s or C-w).
 
 ;;; Code: