diff --git a/README.md b/README.md index be8d936..e263bce 100644 --- a/README.md +++ b/README.md @@ -81,14 +81,14 @@ require("pckr").add({ ## Usage -Gentags will automatically run below jobs in backend when you work in the nvim editor: +Gentags will register several background jobs when you editing files: -- Load a tags for the whole worksapce or the single file on first open a file. -- Generate tags for the whole worksapce or the single file on first open a file. -- Update tags after you save writtens on a file. -- Terminate all background child processes when you leave nvim. +- Locate the workspace root directory, or fallback to single file mode. +- Generate and load tags on first file open. +- Update tags on file save. +- Terminate background jobs on nvim leave. -By default all tags are generated in `stdpath('cache') . '/gentags.nvim'` directory. +By default all tags are generated in `stdpath('cache') . '/gentags.nvim'` directory: - For UNIX/Linux: `~/.cache/nvim/gentags.nvim`. - For Windows: `$env:USERPROFILE\AppData\Local\Temp\nvim\gentags.nvim`. @@ -110,7 +110,7 @@ For complete options and defaults, please see [configs.lua](https://github.com/l Recommend use tags with below plugins to smooth your editing flow: - [vista.vim](https://github.com/liuchengxu/vista.vim): View and search symbols on current file. -- [cmp-nvim-tags](https://github.com/quangnguyen30192/cmp-nvim-tags): Use tags as [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)'s completion data source. +- [cmp-nvim-tags](https://github.com/quangnguyen30192/cmp-nvim-tags): Code completion data source for [nvim-cmp](https://github.com/hrsh7th/nvim-cmp). ## Alternatives