Skip to content

Commit 20ce6ce

Browse files
authored
docs(contents): update other contents (#23)
1 parent adc8a42 commit 20ce6ce

File tree

1 file changed

+45
-4
lines changed

1 file changed

+45
-4
lines changed

README.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# colorbox.nvim
1+
# 🌈 colorbox.nvim
22

33
I'm greedy that I want all the **most popular** Neovim colorschemes than only one, I'm playful that I want to change colorscheme from time to time. Are you like me?
44

@@ -35,25 +35,38 @@ It allow you do any switches with:
3535

3636
Please check [COLORSCHEMES.md](https://github.com/linrongbin16/colorbox.nvim/blob/main/COLORSCHEMES.md) for full colorschemes list.
3737

38-
## Requirement
38+
## 📖 Table of contents
39+
40+
- [Requirement](#-requirement)
41+
- [Install](#-install)
42+
- [lazy.nvim](#lazynvim)
43+
- [Configuration](#-configuration)
44+
- [Development](#-development)
45+
- [Contribute](#-contribute)
46+
47+
## ✅ Requirement
3948

4049
- neovim ≥ 0.8.
4150
- [git](https://git-scm.com/).
4251

43-
## Install
52+
## 📦 Install
4453

4554
### [lazy.nvim](https://github.com/folke/lazy.nvim)
4655

4756
```lua
4857
require('lazy').setup({
4958
{
5059
'linrongbin16/colorbox.nvim',
60+
lazy = false,
5161
build = function() require('colorbox').update() end,
62+
config = function() require('colorbox').setup() end,
5263
}
5364
})
5465
```
5566

56-
## Configuratoin
67+
> Note: don't lazy this plugin since you usually need set `colorscheme` right after start nvim (it costs 3~ ms to start).
68+
69+
## 🔧 Configuration
5770

5871
```lua
5972
require('colorbox').setup({
@@ -63,6 +76,9 @@ require('colorbox').setup({
6376
--- @type "startup"|"interval"|"filetype"
6477
timing = "startup",
6578

79+
--- @type "primary"|fun(color:string):boolean|nil
80+
filter = nil,
81+
6682
--- @type "dark"|"light"|nil
6783
background = nil,
6884

@@ -76,3 +92,28 @@ require('colorbox').setup({
7692
file_log = false,
7793
})
7894
```
95+
96+
## ✏️ Development
97+
98+
To develop the project and make PR, please setup with:
99+
100+
- [lua_ls](https://github.com/LuaLS/lua-language-server).
101+
- [stylua](https://github.com/JohnnyMorganz/StyLua).
102+
- [luarocks](https://luarocks.org/).
103+
- [luacheck](https://github.com/mpeterv/luacheck).
104+
105+
To run unit tests, please install below dependencies:
106+
107+
- [vusted](https://github.com/notomo/vusted).
108+
109+
Then test with `vusted ./test`.
110+
111+
## 🎁 Contribute
112+
113+
Please open [issue](https://github.com/linrongbin16/fzfx.nvim/issues)/[PR](https://github.com/linrongbin16/fzfx.nvim/pulls) for anything about fzfx.nvim.
114+
115+
Like fzfx.nvim? Consider
116+
117+
[![Github Sponsor](https://img.shields.io/badge/-Sponsor%20Me%20on%20Github-magenta?logo=github&logoColor=white)](https://github.com/sponsors/linrongbin16)
118+
[![Wechat Pay](https://img.shields.io/badge/-Tip%20Me%20on%20WeChat-brightgreen?logo=wechat&logoColor=white)](https://github.com/linrongbin16/lin.nvim/wiki/Sponsor)
119+
[![Alipay](https://img.shields.io/badge/-Tip%20Me%20on%20Alipay-blue?logo=alipay&logoColor=white)](https://github.com/linrongbin16/lin.nvim/wiki/Sponsor)

0 commit comments

Comments
 (0)