From ec1e424a1103407a9ff55aff75d30d6fffcc79af Mon Sep 17 00:00:00 2001 From: Bram Schoenmakers Date: Wed, 24 Jul 2024 21:00:15 +0200 Subject: [PATCH] Update README --- README.org | 22 +++++++++++++--------- kagi.info | Bin 17382 -> 17821 bytes 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/README.org b/README.org index 07c8915..765c53c 100644 --- a/README.org +++ b/README.org @@ -58,7 +58,9 @@ To install from Git, clone with: : git clone https://codeberg.org/bram85/kagi.el.git /path/to/kagi.el -Note that kagi.el has a dependency on the [[https://melpa.org/#/shell-maker][shell-maker package]], which is available on MELPA. +kagi.el has two dependencies (both available on MELPA): +- [[https://melpa.org/#/markdown-mode][markdown-mode]] to apply formatting of the Markdown responses in FastGPT; +- [[https://melpa.org/#/shell-maker][shell-maker]] to provide a shell interface for FastGPT. You may want to load and configure the package with ~use-package~, for example put the following in your Emacs init file: @@ -73,14 +75,7 @@ You may want to load and configure the package with ~use-package~, for example p ;; Universal Summarizer settings (kagi-summarizer-engine "cecil") (kagi-summarizer-default-language "EN") - (kagi-summarizer-cache t) - :custom-face - ;; kagi-code defaults to fixed-pitch, but can be overridden as - ;; follows: - (kagi-code ((t (:inherit org-verbatim)))) - - ;; likewise for kagi-bold: - (kagi-bold ((t (:inherit modus-themes-bold))))) + (kagi-summarizer-cache t)) #+end_src The API token can be supplied directly as a string, but you could write a lambda to retrieve the token from a more secure location (e.g. with the combination of [[https://passwordstore.org/][pass(1)]] and the /password-store/ package that comes with it). @@ -260,12 +255,21 @@ Needless to say, the tests won't make actual API calls. Otherwise it wouldn't be * Changelog +#+begin_comment +If you read this from an HTML/info export of this README: +#+end_comment + The full changelog can be found in README.org. ** 0.6pre +*** Breaking changes + +- Obsoleted faces =kagi-bold=, =kagi-italic= and =kagi-code= in favor of formatting by markdown-mode. + *** New +- Full support for markdown syntax returned by FastGPT, by using the [[https://github.com/jrblevin/markdown-mode][markdown-mode]] package. - Show a welcome message when starting the FastGPT shell (=kagi-fastgpt-shell=). This can be customized with =kagi-fastgpt-welcome-function=, a variable with a function that returns a welcome string. *** Misc diff --git a/kagi.info b/kagi.info index 7f9725f13b4e29f54ad1038ee828d25239675933..a9eba57d38390f04219d8bd7ad0c5c83955b4bb2 100644 GIT binary patch delta 1031 zcmZ`&zi-n(6jqY9gGE(QN(EKaKGX=cC~@pKj_oi&6A0o*OI5KkU7Sl|;`m(qlD3nB zKtd`D;uaWKI>CZK8ITYI48Y32K#|J7!8x%jio{KK-@W&}?|tv?=t<($)5N<$k`d!P zdz{S7L&d|WV>vA_+sJ8QA6Dd5kv%lh!>`G~si1>emWXX=BOmAvfd+Q5)4+~tg`ssq z+kpDWvQgc}Kpa@VerI!SwJZR@;otze$m=x7j+5(>28NY3rLJGj=eyW;kx0B&emQ?4 zWECg@E?q^0$-O?_y4@Q~|^;vdg z6oR{TpV*k<284+|Z}mlJRIX0!#^K;)_871zvMrNCfSkrLYH~9|jO%WqKJmsvcz=I& zTi-iro+t=QLd~*q89FRmI?Y_|40~Q)3`(wt1wj>Mu>c!*N65uXh`p%wY#aQZ>k^NS znv5+6f6t+4mpe&&p2NH0MI$4#;lAgGzH`&Z0^_t3!(_i#rs09d$KSV{e~0NJlly|j z;eocCNGR-^{_+1Wt~L?AJ@(!BIob?gmw!#A)PlgaC)108T$EK|gBw?lB?fXyQN|G4 zzH)XdD5wUH{yd$@1d3WLMA5hTU|?|#Z c*}_fi@xM8Oi)x%)C49;z<)ON!v$s|K54@XFaR2}S delta 841 zcmZ9Kv2W8r6vma%B4kxis0x*+=#$zZMNQ&!Vmo%KRjO<9+_&-=#kXZQ_xFj~JdfWTmyHDTy?tT4O`tzam{h};4>_z#lyduHA zA@8=A$A8Ng3qgko1mRNwXLJzMFa)1+pwPnv;~vJ|TVSzjK;S-xVKt&>m_kB5)s9-l z7b4+qy&hqh&>Bkz_4WFt#?37l`GMy{z~$##OXGKobLC8f*>Sxg7c8pwsfPt?x2Ha; z9_yj<(5J&ta1ado!5i#VlR$X>7IcRKJQ_n6ft_QT20i5zD8HoAXJN=j+$~ULGTu}+ zgGxm}#SLN~(?EbST~#7oDuQTJ9j$nxyoA9SjslL*XX(sXmxaA6q7!sQGh)3Vud37{ z~huKOeZtX=uq zUXa-SIo{d+ef=8IHTh+J^+84&c0=o^tXw#xTpS&rWW;pH49N>^S<4L5)Tgz4Q3J>t zramiOc&ZYCN5@ZqqZlTcX%JhJYb&esnPm`N{@Pz(bBf;Q=>YatDk%$)E0G#;p%fub$b$>}tKj5KxA%1H-D zswP%ZKMT00K=c2+x~WQw6uNt