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 19:57:25 +01:00
parent 244eae6971
commit 6e9ec0a86e
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -3,19 +3,20 @@
A [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) extension that offers intelligent prioritization when selecting files from your editing history.
Using an implementation of Mozilla's [Frecency algorithm](https://developer.mozilla.org/en-US/docs/Mozilla/Tech/Places/Frecency_algorithm) (used in [Firefox's address bar](https://support.mozilla.org/en-US/kb/address-bar-autocomplete-firefox)), files edited _frecently_ 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_
* _Scores shown in finder for demonstration purposes - disabled by default_
## Frecency: Sorting by 'frequency' _and_ 'recency'
'Frecency' is a score given to each unique file indexed in a file history database.
A timestamp is recorded once per session when a file is loaded into a buffer.
A timestamp is recorded once per session when a file is first loaded into a buffer.
The score is calculated using the age of the 10 most recent timestamps and the total amount of times the file has been loaded:
The score is calculated using the age of the 10 most recent timestamps and the total amount of times that the file has been loaded:
### Recency values (per timestamp)