[elpa] externals/kiwix c0c597d 14/18: Improve package config examples on README

[monnier--- via]

branch: externals/kiwix
commit c0c597d1e1653112f3e10c67dcc22d85beb2aed8
Author: stardiviner <numbch...@gmail.com>
Commit: stardiviner <numbch...@gmail.com>

    Improve package config examples on README
---
 README.org | 43 ++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 40 insertions(+), 3 deletions(-)

diff --git a/README.org b/README.org
index 360b37f..f446032 100644
--- a/README.org
+++ b/README.org
@@ -305,15 +305,52 @@ docker container ls --all | grep "kiwix-serve" | cat
 
 ** use-package
 
+*** for local kiwix-serve server
+
 #+begin_src emacs-lisp
 (use-package kiwix
   :ensure t
   :after org
-  :custom ((kiwix-server-use-docker t)
+  :commands (kiwix-launch-server kiwix-at-point)
+  :bind (:map document-prefix ("w" . kiwix-at-point))
+  :custom ((kiwix-server-type 'kiwix-serve-local)
+           (kiwix-server-url "http://127.0.0.1";)
            (kiwix-server-port 8089)
-           (kiwix-default-library "wikipedia_en_all_2016-02.zim") ; 
"wikipedia_zh_all_2015-11.zim"
-           (kiwix-default-browser-function 'eww))
+           (kiwix-zim-dir (expand-file-name "/path/to/kiwix_zim_libraries")))
+  :hook (org-load . org-kiwix-setup-link)
+  :init (require 'org-kiwix)
+  :config (add-hook 'org-load-hook #'org-kiwix-setup-link))
+#+end_src
+
+*** for local Docker server
+
+#+begin_src emacs-lisp
+(use-package kiwix
+  :ensure t
+  :after org
+  :commands (kiwix-launch-server kiwix-at-point)
+  :bind (:map document-prefix ("w" . kiwix-at-point))
+  :custom ((kiwix-server-type 'docker-local)
+           (kiwix-server-url "http://127.0.0.1";)
+           (kiwix-server-port 8089)
+           (kiwix-zim-dir (expand-file-name "/path/to/kiwix_zim_libraries")))
+  :hook (org-load . org-kiwix-setup-link)
+  :init (require 'org-kiwix)
+  :config (add-hook 'org-load-hook #'org-kiwix-setup-link))
+#+end_src
+
+*** for remote Docker server
+
+#+begin_src emacs-lisp
+(use-package kiwix
+  :ensure t
+  :after org
   :commands (kiwix-launch-server kiwix-at-point)
+  :bind (:map document-prefix ("w" . kiwix-at-point))
+  :custom ((kiwix-server-type 'docker-remote)
+           (kiwix-server-url "http://192.168.31.251";)
+           (kiwix-server-port 8089))
+  :hook (org-load . org-kiwix-setup-link)
   :init (require 'org-kiwix)
   :config (add-hook 'org-load-hook #'org-kiwix-setup-link))
 #+end_src