From: Eshel Yaron <me@eshelyaron.com>
Date: Tue, 9 May 2023 17:27:04 +0000 (+0300)
Subject: * README.org: (Example Config): new section
X-Git-Tag: v0.1.6~6
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=212c2ca9b6e5ef017b92dc264eebf91c069b678d;p=dict.git

* README.org: (Example Config): new section
---

diff --git a/README.org b/README.org
index 0f0faf2..ea8fe18 100644
--- a/README.org
+++ b/README.org
@@ -106,7 +106,6 @@ The following user options affect the behavior of ~dict-describe-word~:
   connection process.  Defaults to "dict".
 - User Option: dict-process-buffer-name :: Name of the buffer to use for the
   dictionary server connection process output.  Defaults to "*​dict output*".
-  #+FINDEX: dict-display-definition-in-help-buffer
 - User Option: dict-display-definition-function :: Function to use for
   displaying word definitions.  The function must take two string arguments, the
   word and its definition, and display the definition to the user.  Defaults to
@@ -175,6 +174,28 @@ completion, using the word at point as the minibuffer's "future
 history".  This is also what ~dict-describe-word~ uses to prompt for a
 word when you call it interactively.
 
+* Example Configuration
+:PROPERTIES:
+:CUSTOM_ID: example-config
+:DESCRIPTION: Example Dict configuration
+:ALT_TITLE: Example Config
+:END:
+
+Here's an example configuration for Dict:
+
+#+begin_src emacs-lisp
+  (with-eval-after-load 'dict
+    ;; some settings
+    (setq dict-server-host "dict.org"
+          dict-dictionary  "gcide"
+          dict-strategy    "prefix"))
+
+  (keymap-global-set "M-#" #'dict-describe-word)
+#+end_src
+
+If you install Dict as a package ~dict-describe-word~ is autoloaded on
+demand, so there's no need for to ~require~ anything before you use it.
+
 * Motivation Behind Dict
 :PROPERTIES:
 :CUSTOM_ID: motivation