branch: externals/auth-source-xoauth2-plugin
commit 9f7a58daee150d9d69754f74718711e3e4de052a
Author: Xiyue Deng <[email protected]>
Commit: Xiyue Deng <[email protected]>
Update documentation for the global minor mode accordingly
---
auth-source-xoauth2-plugin.el | 30 ++++++++++++++++--------------
1 file changed, 16 insertions(+), 14 deletions(-)
diff --git a/auth-source-xoauth2-plugin.el b/auth-source-xoauth2-plugin.el
index 46580641e8..cdcc9e7ee7 100644
--- a/auth-source-xoauth2-plugin.el
+++ b/auth-source-xoauth2-plugin.el
@@ -23,30 +23,32 @@
;;; Commentary:
-;; This package enables support for xoauth2 authentication with
-;; auth-source. OAuth 2.0, which stands for “Open Authorization”, is a
-;; standard designed to allow a website or application to access
-;; resources hosted by other web apps on behalf of a user. The OAuth
-;; 2.0 Authorization Protocol Extensions (xoauth2) extend the OAuth 2.0
-;; Authentication Protocol and the JSON Web Token (JWT) to enable
-;; server-to-server authentication. More info please check out:
-;; https://stackoverflow.com/a/76389679/2337550
-
-;; To set up, please put this file in the `load-path' of
-;; Emacs, and add the following lines in your Emacs configuration:
+;; This package provides a global minor mode for enabling support for
+;; xoauth2 authentication with auth-source. OAuth 2.0, which stands for
+;; “Open Authorization”, is a standard designed to allow a website or
+;; application to access resources hosted by other web apps on behalf of
+;; a user. The OAuth 2.0 Authorization Protocol Extensions (xoauth2)
+;; extend the OAuth 2.0 Authentication Protocol and the JSON Web Token
+;; (JWT) to enable server-to-server authentication. More info please
+;; check out: https://stackoverflow.com/a/76389679/2337550
+
+;; 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)
+;; (auth-source-xoauth2-plugin-mode t)
;; or with use-package:
;; (use-package auth-source-xoauth2-plugin
;; :config
-;; (auth-source-xoauth2-plugin-enable))
+;; (auth-source-xoauth2-plugin-mode t))
;; After enabling, smtpmail should be supported. To enable this in Gnus
;; nnimap, you should also set `(nnimap-authenticator xoauth2)' in the
-;; corresponding account settings in `gnus-secondary-select-methods'
+;; corresponding account settings in `gnus-secondary-select-methods'.
+;; To disable, just toggle the minor mode off by calling `M-x
+;; auth-source-xoauth2-plugin-mode' again.
;; auth-source uses the `secret' field in auth-source file as password
;; for authentication, including xoauth2. To decide which
