kristoferssolo/telescope-frecency.nvim
1
0
Fork 0
mirror of https://github.com/kristoferssolo/telescope-frecency.nvim.git synced 2025-10-21 20:10:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Senghan Bright 2021-01-17 11:11:35 +01:00
parent e71670b0a7
commit 73c48b2099
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -5,6 +5,10 @@ Frecency is a [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
Using an implementation of Mozilla's [Frecency algorithm](https://developer.mozilla.org/en-US/docs/Mozilla/Tech/Places/Frecency_algorithm), files that you edit often and/or recently are given higher precedence in the list index.
As the extension 'learns' your editing habits over time, the sorting of the list is dynamically altered to priotize the files you're likely to need.
<img src="https://raw.githubusercontent.com/sunjon/images/master/gh_readme_telescope_frecency.png" alt="screenshot" width="800"/>
* _Scores shown in finder for illustration purposes only_
## Frecency: sorting by "frequency" and "recency"
Frecency is a score given to each unique file loaded into a Neovim buffer.
@ -28,10 +32,7 @@ The score is calculated using the age of the 10 most recent timestamps and the t
```
score = frequency * recency_score / max_number_of_timestamps
<img src="https://raw.githubusercontent.com/sunjon/images/master/gh_readme_telescope_frecency.png" alt="screenshot" width="800"/>
* _Scores shown in finder for illustration purposes only_
```
## Requirements
@ -41,8 +42,6 @@ score = frequency * recency_score / max_number_of_timestamps
Timestamps and file records are stored in an [SQLite3](https://www.sqlite.org/index.html) database for persistence and speed.
This plugin uses `sql.nvim` to perform the database transactions.
## Installation
TODO: add installation instructions for other package managers