Skip to content
This repository was archived by the owner on May 16, 2024. It is now read-only.

Commit afb4d19

Browse files
update: README.md
precise usage instruction and add similar projects
1 parent 84e474b commit afb4d19

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ Here is the default configuration:
7878
}
7979
```
8080

81+
## Usage
82+
83+
To use the documentations from nvim-devdocs you have to **install** the documentation using `:DevdocsInstall`.
84+
8185
## Commands
8286

8387
Available commands:
@@ -108,6 +112,10 @@ The HTML converter is still experimental, and not all documentation has been tho
108112

109113
Pull requests and feature requests are welcome!
110114

115+
## Similar projects
116+
117+
- [nvim-telescope-zeal-cli](https://gitlab.com/ivan-cukic/nvim-telescope-zeal-cli) Show Zeal documentation pages in Neovim Telescope.
118+
111119
## Credits
112120

113121
- [The DevDocs project](https://github.com/freeCodeCamp/devdocs) for the documentations.

0 commit comments

Comments
 (0)