emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/minuet cc8c890413 57/97: doc: update README and package


From: ELPA Syncer
Subject: [elpa] externals/minuet cc8c890413 57/97: doc: update README and package description.
Date: Mon, 24 Mar 2025 18:59:16 -0400 (EDT)

branch: externals/minuet
commit cc8c890413cab2008e7674b4b9ef55627fcf5766
Author: Milan Glacier <dev@milanglacier.com>
Commit: Milan Glacier <dev@milanglacier.com>

    doc: update README and package description.
---
 README.md | 20 ++++++++++++--------
 minuet.el | 17 +++++++++++++----
 2 files changed, 25 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index fad4351afb..233adc49d5 100644
--- a/README.md
+++ b/README.md
@@ -56,13 +56,15 @@ Just as dancers move during a minuet.
 
 # Installation
 
-Currently you need to install from github via `package-vc` or `straight`, or
-manually install this package.
+`minuet` is available on MELPA and can be installed using your preferred 
package
+managers.
 
 ```elisp
 
+;; install with package.el
+(package-install 'minuet)
 ;; install with straight
-(straight-use-package '(minuet :host github :repo "milanglacier/minuet-ai.el"))
+(straight-use-package 'minuet)
 
 (use-package minuet
     :bind
@@ -512,11 +514,13 @@ If your setup failed, there are two most likely reasons:
 
 1. You are setting the API key to a literal value instead of the environment
    variable name.
-2. You are using a context window that is too large, causing completion items
-   to timeout before returning. It is recommended to:
+2. You are using a model or a context window that is too large, causing
+   completion items to timeout before returning any tokens. It is recommended
+   to:
    - Test with manual completion first
    - Use a smaller context window (e.g., `context_window = 768`)
-   - Set a longer request timeout (e.g., `request_timeout = 5`) to
-     evaluate your provider's response time
+   - Use a smaller model
+   - Set a longer request timeout (e.g., `request_timeout = 5`) to evaluate 
your
+     provider's inference latency.
 
-To diagnose issues, examine the buffer content from `*minut*`
+To diagnose issues, examine the buffer content from `*minuet*`.
diff --git a/minuet.el b/minuet.el
index d8183d133f..bcaf0a57c8 100644
--- a/minuet.el
+++ b/minuet.el
@@ -2,7 +2,7 @@
 
 ;; Author: Milan Glacier <dev@milanglacier.com>
 ;; Maintainer: Milan Glacier <dev@milanglacier.com>
-;; Version: 0.1
+;; Version: 0.3
 ;; URL: https://github.com/milanglacier/minuet-ai.el
 ;; Package-Requires: ((emacs "29") (plz "0.9") (dash "2.19.1"))
 
@@ -26,9 +26,18 @@
 ;; Floor, Boston, MA 02110-1301, USA.
 
 ;;; Commentary:
-;; This package implements an AI-powered code completion tool for
-;; Emacs.  It supports to use a variety of LLMs to generate code
-;; completions.
+;; AI-powered code completion with dual modes:
+;;
+;; - Specialized prompts and various enhancements for chat-based LLMs on code 
completion tasks.
+;; - Fill-in-the-middle (FIM) completion for compatible models (DeepSeek, 
Codestral, and some Ollama models).
+;;
+;; Minuet supports multiple AI providers (OpenAI, Claude, Gemini,
+;; Codestral, Ollama, and OpenAI-compatible providers)
+;;
+;; You can use it with overlay-based popup via
+;; `minuet-show-suggestion' or selecting the candidates via
+;; `minuet-complete-with-minibuffer'.  You can toggle automatic
+;; suggestion popup with `minuet-auto-suggestion-mode'.
 
 ;;; Code:
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]