From a30d019efc81fe9b4772100ecd3d4a794dae6c45 Mon Sep 17 00:00:00 2001 From: Stephen Waits Date: Thu, 19 Oct 2023 17:28:49 -0600 Subject: [PATCH] update README.md --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 86ac242..274be14 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ # thethethe -This is an autocorrect plugin for common misspellings and typos. If you type 'teh', neovim will automatically correct it to 'the'. +This is a Neovim plugin to autocorrect common misspellings and typos. If you +type _teh_, neovim will automatically correct it to _the_. -It's based on [vim-autocorrect](https://github.com/panozzaj/vim-autocorrect), but designed for Neovim. - -It defers loading the dictionary, so it doesn't delay startup time. +It's based on [vim-autocorrect](https://github.com/panozzaj/vim-autocorrect), +but designed for Neovim. Unlike that plugin, this loads the dictionary in the +background, so it doesn't delay startup time. ## Installing -### [lazy](https://github.com/folke/lazy.nvim) +### [lazy](https://github.com/folke/lazy.nvim) (recommended) ```lua { @@ -40,8 +41,15 @@ lua require("thethethe").setup() The default configuration options are listed below: ```lua -require("thethethe").setup({ +opts = { -- Time (milliseconds) to wait before loading abbreviations delay_ms = 2000 -}) +} ``` + +## Future Directions + +- Allow specifying a custom dictionary files +- List custom dictionary entries directly in `opts {}` +- Split current (large!) dictionary into something like small, medium, large +- Recategorize current dictionary "English" and add options to include non-English dictionaries