Skip to content

Commit

Permalink
Add note about completion-preview-mode, & toc (#164)
Browse files Browse the repository at this point in the history
  • Loading branch information
raxod502 authored Sep 26, 2024
1 parent 2b8a8b4 commit 7dd5b53
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,23 @@ including [IDO], [Ivy], [Helm], [Smex], [Flx], [Historian], and
[Company-Statistics], `prescient.el` aims to be simpler, more
predictable, and faster.

<!-- toc -->

- [Installation](#installation)
- [Usage](#usage)
- [Algorithm](#algorithm)
- [Configuration and other features](#configuration-and-other-features)
* [Faces](#faces)
* [For the completion style](#for-the-completion-style)
* [For Corfu](#for-corfu)
* [For Company](#for-company)
* [For Ivy](#for-ivy)
* [For Selectrum](#for-selectrum)
* [For Vertico](#for-vertico)
- [Contributor guide](#contributor-guide)

<!-- tocstop -->

## Installation

`prescient.el` is available on MELPA as six separate packages (one
Expand Down Expand Up @@ -377,6 +394,14 @@ Vertico:
`prescient-completion-sort` and `vertico-prescient-enable-sorting` is
made non-nil.

## Compatibility with other packages

For use with `completion-preview-mode` in Emacs 30:

```elisp
(setq completion-preview-sort-function #'prescient-completion-sort)
```

## Contributor guide

Please see [the contributor guide for my
Expand Down

0 comments on commit 7dd5b53

Please sign in to comment.