From b674150b15913eb0b7bca0c97b189944d4d5da87 Mon Sep 17 00:00:00 2001 From: Senghan Bright Date: Thu, 14 Jan 2021 02:57:17 +0100 Subject: [PATCH] update readme --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fade8c9..bd20510 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # telescope-frecency.nvim -An implementation of Mozillas [Frecency algorithm](https://developer.mozilla.org/en-US/docs/Mozilla/Tech/Places/Frecency_algorithm) for [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim). +An implementation of Mozilla's [Frecency algorithm](https://developer.mozilla.org/en-US/docs/Mozilla/Tech/Places/Frecency_algorithm) for [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim). ## Frecency: sorting by "frequency" and "recency" Frecency is a score given to each unique file loaded into a Neovim buffer. -On each load a timestamp is recorded to a database. The score is calculated using the age of each of the timestamps and the amount of times the file has been loaded: +On each load a timestamp is recorded to a database. The score is calculated using the age of each of (up to 10) timestamps and the total amount of times the file has been loaded: ### Recency values (per timestamp) @@ -70,3 +70,8 @@ lua require("telescope").extensions.frecency.frecency(opts) ``` :Telescope frecency ``` + +## References + +- [Stack Engineering: A faster smarter quick switcher](https://slack.engineering/a-faster-smarter-quick-switcher/) +- [Mozilla Frecency algorithm](https://developer.mozilla.org/en-US/docs/Mozilla/Tech/Places/Frecency_algorithm)