[nongnu] elpa/opam-switch-mode 3d63566b0d 04/31: provide README

[ELPA Syncer]

branch: elpa/opam-switch-mode
commit 3d63566b0d67e55dcfb29bc64b0a8697449b0209
Author: Hendrik Tews <Hendrik.Tews@kernkonzept.com>
Commit: Hendrik Tews <Hendrik.Tews@kernkonzept.com>

    provide README
---
 README.md    | 13 +++++++++++++
 opam-mode.el |  3 +++
 2 files changed, 16 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..f55d50df8d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# opam mode
+
+Provide command `opam-set-switch` to change the opam switch of the
+running emacs session. The command reads the name of the switch in
+the minibuffer, providing completion with all available switches.
+With no input (i.e., leaving the minibuffer empty) the environment
+is reset to the state before the first call of `opam-set-switch`.
+
+For obvious reasons, `opam-set-switch` does not change the switch
+of any other shell.
+
+Contrary to the file name, this file does not (yet) provide a minor
+mode.
diff --git a/opam-mode.el b/opam-mode.el
index dcd1a541dd..9b42e090da 100644
--- a/opam-mode.el
+++ b/opam-mode.el
@@ -32,6 +32,9 @@
 ;;
 ;; For obvious reasons, `opam-set-switch' does not change the switch
 ;; of any other shell.
+;;
+;; Contrary to the file name, this file does not (yet) provide a minor
+;; mode.
 ;; 
 
 (require 'seq)