diff --git a/README.md b/README.md index 2b7912f..5a83f6a 100644 --- a/README.md +++ b/README.md @@ -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. screenshot -* _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)