branch: externals/auth-source-xoauth2-plugin
commit 7b730e3763a74f6ab41b26615d8a2d0220896fed
Author: Xiyue Deng <manp...@gmail.com>
Commit: Xiyue Deng <manp...@gmail.com>
Add notes on installation and setup.
---
auth-source-xoauth2-plugin.el | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/auth-source-xoauth2-plugin.el b/auth-source-xoauth2-plugin.el
index f540b5628c..1a3d6e510c 100644
--- a/auth-source-xoauth2-plugin.el
+++ b/auth-source-xoauth2-plugin.el
@@ -24,7 +24,17 @@
;;; Commentary:
;; This package enables support for xoauth2 authentication with
-;; auth-source.
+;; auth-source. To set up, please put this file in the `load-path' of
+;; Emacs, and add the following lines in your Emacs configuration:
+
+;; (require 'auth-source-xoauth2-plugin)
+;; (auth-source-xoauth2-plugin-enable)
+
+;; or with use-package:
+
+;; (use-package auth-source-xoauth2-plugin
+;; :config
+;; (auth-source-xoauth2-plugin-enable))
;; auth-source uses the `secret' field in auth-source file as password
;; for authentication, including xoauth2. To decide which
