Skip to content

Commit 9e26bfe

Browse files
committed
docs: usage
1 parent 359ab14 commit 9e26bfe

File tree

2 files changed

+15
-20
lines changed

2 files changed

+15
-20
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -291,14 +291,19 @@ Leet list status=<status> difficulty=<difficulty>
291291

292292
## 🚀 Usage
293293

294-
This plugin is meant to be used within a **fresh** [Neovim] instance.
295-
Meaning that to launch [leetcode.nvim] you **have** to pass
296-
[`arg`](#arg) as the _first and **only**_ [Neovim] argument
294+
This plugin can be initiated in two ways:
295+
296+
- To start [leetcode.nvim], simply pass [`arg`](#arg)
297+
as the _first and **only**_ [Neovim] argument
297298

298299
```
299300
nvim leetcode.nvim
300301
```
301302

303+
- _**(Experimental)**_ Alternatively, you can use `:Leet` command to open [leetcode.nvim]
304+
within your preferred dashboard plugin. The only requirement is that [Neovim]
305+
must not have any listed buffers open.
306+
302307
### Switching between questions
303308

304309
To switch between questions, use `Leet tabs`
@@ -329,13 +334,6 @@ return {
329334
}
330335
```
331336

332-
## ✅ Todo
333-
334-
- \[x\] CN version
335-
- \[x\] Statistics menu page
336-
- \[ \] Docs
337-
- \[x\] Hints pop-up
338-
339337
## 🙌 Credits
340338

341339
- [Leetbuddy.nvim](https://github.com/Dhanus3133/Leetbuddy.nvim)

README.zh.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -294,14 +294,18 @@ Leet list status=<status> difficulty=<difficulty>
294294

295295
## 🚀 使用方法
296296

297-
此插件应该在 **全新**[Neovim] 实例中使用。
298-
这意味着要启动 [leetcode.nvim],您 **必须**
299-
[`arg`](#arg) 作为 _第一个且 **唯一**_ [Neovim] 参数
297+
该插件可以通过两种方式启动:
298+
299+
- 要启动 [leetcode.nvim],只需将 [`arg`](#arg)
300+
作为 第一个且唯一 [Neovim] 参数传递
300301

301302
```
302303
nvim leetcode.nvim
303304
```
304305

306+
- _**(实验性)**_ 另外,您可以使用 `:Leet` 命令在您喜欢的仪表板插件中打开
307+
[leetcode.nvim]。唯一的要求是 [Neovim] 不能有任何列出的缓冲区打开。
308+
305309
### 切换问题
306310

307311
要在问题之间切换,请使用 `Leet tabs`
@@ -332,13 +336,6 @@ return {
332336
}
333337
```
334338

335-
## ✅ 待办事项
336-
337-
- \[x\] 中文版本
338-
- \[x\] 统计菜单页面
339-
- \[ \] 文档
340-
- \[x\] 提示弹出窗口
341-
342339
## 🙌 鸣谢
343340

344341
- [Leetbuddy.nvim](https://github.com/Dhanus3133/Leetbuddy.nvim)

0 commit comments

Comments
 (0)