[nongnu] elpa/opam-switch-mode dea35145a3 30/31: Merge pull request #7 from ProofGeneral/add-doc

[ELPA Syncer]

branch: elpa/opam-switch-mode
commit dea35145a39b80b7d1df217395928d76abab0b13
Merge: 5f3d2102ae e681cbdcb7
Author: Erik Martin-Dorel <erik@martin-dorel.org>
Commit: GitHub <noreply@github.com>

    Merge pull request #7 from ProofGeneral/add-doc
    
    Enhance documentation
---
 README.md           | 24 +++++++++++++++++++++---
 opam-switch-mode.el |  5 +++--
 2 files changed, 24 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 0b075fe9a7..7f7e65dee0 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# opam switch mode
+# opam-switch-mode
+
+[![MELPA](https://melpa.org/packages/opam-switch-mode-badge.svg)](https://melpa.org/#/opam-switch-mode)
 
 Provide command `opam-switch-set-switch` to change the opam switch of the
 running emacs session and minor mode `opam-switch-mode` to select the opam
@@ -9,6 +11,22 @@ switches that are known at that time. If you create a new 
switch, re-enable
 the minor mode to get it added to the menu. The menu contains an additional
 entry "reset" to reset the environment to the state when emacs was started.
 
+## Installing `opam-switch-mode`
+
+The recommended way to install the mode relies on the
+[MELPA](https://melpa.org/) repository of Emacs packages, and the
+[`use-package`](https://github.com/jwiegley/use-package) macro.
+Assuming you have already set up those in your `.emacs`, just write:
+
+```elisp
+(use-package opam-switch-mode
+  :ensure t
+  :hook
+  (coq-mode . opam-switch-mode))
+```
+
+so that the minor mode is automatically enabled when `coq-mode` is on,
+see also [`opam-switch-mode` aware modes](#opam-switch-mode-aware-modes).
 
 ## Command `opam-switch-set-switch`
 
@@ -36,8 +54,8 @@ that depend on the currently active opam switch.
 For obvious reasons, `opam-switch-set-switch` will only affect emacs and not
 any other shells outside emacs.
 
-## opam-switch-mode aware modes
+## `opam-switch-mode` aware modes
 
-- [Proof General](https://proofgeneral.github.io/)
+- `coq-mode` from [`proof-general`](https://proofgeneral.github.io/)
   can kill the coq background process, when the opam switch changes,
   see 
[`coq-kill-coq-on-opam-switch`](https://proofgeneral.github.io/doc/master/userman/Coq-Proof-General/#index-coq_002dkill_002dcoq_002don_002dopam_002dswitch).
diff --git a/opam-switch-mode.el b/opam-switch-mode.el
index 826f315d6a..7b7ef88ab4 100644
--- a/opam-switch-mode.el
+++ b/opam-switch-mode.el
@@ -1,9 +1,10 @@
 ;;; opam-switch-mode.el --- Select OCaml opam switches via a menu -*- 
lexical-binding: t; -*-
 ;;
-;; Copyright (C) 2021 Hendrik Tews
+;; Copyright (C) 2022  Hendrik Tews
+;; Copyright (C) 2022  Erik Martin-Dorel
 ;;
 ;; Authors: Hendrik Tews
-;; Maintainer: Hendrik Tews <hendrik@askra.de>
+;; Maintainer: proof-general-maintainers@groupes.renater.fr
 ;; URL: https://github.com/ProofGeneral/opam-switch-mode
 ;; Package-Requires: ((emacs "25.1"))
 ;; Version: 1.0-git