From 73c48b2099d26bbf9a221b66d84d34a2bce0cd85 Mon Sep 17 00:00:00 2001 From: Senghan Bright Date: Sun, 17 Jan 2021 11:11:35 +0100 Subject: [PATCH] update readme --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b0d574f..fef12c5 100644 --- a/README.md +++ b/README.md @@ -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. +screenshot + +* _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 - -screenshot - -* _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