From 0f699b86a4c7e5f42a0b4e6f1c029af562a5077f Mon Sep 17 00:00:00 2001
From: Bram Schoenmakers <me@bramschoenmakers.nl>
Date: Sat, 23 Dec 2023 19:17:08 +0100
Subject: [PATCH] Add README

---
 README.org | 40 ++++++++++++++++++++++++++++++++++++++++
 kagi.el    | 16 ++++++++++++++--
 2 files changed, 54 insertions(+), 2 deletions(-)
 create mode 100644 README.org

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..98d5d7f
--- /dev/null
+++ b/README.org
@@ -0,0 +1,40 @@
+#+title: kagi.el README
+#+author: Bram Schoenmakers
+
+* Introduction
+
+This package provides a shell to submit prompts to FastGPT, inspired by [[https://github.com/xenodium/chatgpt-shell][xenodium's chatgpt-shell]].
+
+Kagi is a relatively new ad-free search engine, offering additional services such as the [[https://kagi.com/summarizer][Universal Summarizer]] or more notably [[https://kagi.com/fastgpt][FastGPT]], their open source LLM offering. Some functionality is provided through an API.
+
+* Usage
+
+1. Make a Kagi account if you haven't done so already. An account is free, and comes with 100 trial searches.
+2. In [[https://kagi.com/settings?p=billing_api][your account settings]], put a balance for the API part (note that this is a separate balance than the subscription). The recommendation is to start with a one-time charge of $5. A single query ranges from 1 to 5 cents typically, depending on the amount of tokens processed.
+3. In [[https://kagi.com/settings?p=api][the API portal]], create an API token. Put the result in ~kagi-api-token~.
+4. You're good to go: run the command ~kagi-fastgpt-shell~ and start prompting.
+
+* Installation and configuration
+
+kagi.el is not on MELPA (yet?), so for now only Git access is possible.
+
+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.
+
+You way want to load and configure the package with ~use-package~, for example put the following in your Emacs init file:
+
+#+begin_src elisp
+  (use-package kagi
+    :commands kagi-fastgpt-shell
+    :ensure nil
+    :load-path "/path/to/kagi.el"
+    :custom
+    (kagi-api-token "ABCDEF")
+    ;; or use a function, e.g. with the password-store package:
+    (kagi-api-token (lambda () (password-store-get "Kagi/API"))))
+#+end_src
+
+The 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. [[https://passwordstore.org/][pass(1)]]).
diff --git a/kagi.el b/kagi.el
index 3239336..9fc14e4 100644
--- a/kagi.el
+++ b/kagi.el
@@ -36,8 +36,20 @@
 
 ;;; Commentary:
 
-;; TODO
-
+;; This package provides a shell to submit prompts to FastGPT, inspired by
+;; [xenodium's chatgpt-shell].
+;;
+;; Kagi is a relatively new ad-free search engine, offering additional
+;; services such as the [Universal Summarizer] or more notably [FastGPT],
+;; their open source LLM offering. Some functionality is provided through
+;; an API.
+;;
+;; [xenodium's chatgpt-shell] <https://github.com/xenodium/chatgpt-shell>
+;;
+;; [Universal Summarizer] <https://kagi.com/summarizer>
+;;
+;; [FastGPT] <https://kagi.com/fastgpt>
+;;
 ;; API documentation: https://help.kagi.com/kagi/api/fastgpt.html
 
 ;;; Code: