From 26f635713a1b16f74a1835b67a5268c3e885f935 Mon Sep 17 00:00:00 2001 From: Marc Jakobi Date: Sun, 17 Dec 2023 22:43:54 +0100 Subject: [PATCH] docs(readme): add links to rocks-git and rocks-config modules (#89) --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b1b4301a..da015c9c 100644 --- a/README.md +++ b/README.md @@ -118,16 +118,26 @@ that are no longer needed, run the `:Rocks prune [rock]` command. The `:Rocks edit` command opens the `rocks.toml` file for manual editing. Make sure to run `:Rocks sync` when you are done. -### Troubleshooting +## :stethoscope: Troubleshooting The `:Rocks log` command opens a log file for the current session, which contains the `luarocks` stderr output, among other logs. -## :waning_crescent_moon: Lua API +## :package: Extending `rocks.nvim` This plugin provides a Lua API for extensibility. See [`:h rocks.api`](./doc/rocks.txt) for details. +Following are some examples: + +- [`rocks-git.nvim`](https://github.com/nvim-neorocks/rocks-git.nvim): + Adds the ability to install plugins from git. +- [`rocks-config.nvim`](https://github.com/nvim-neorocks/rocks-config.nvim): + Adds an API for safely loading plugin configurations. + +To extend `rocks.nvim`, simply install a module with `:Rocks install`, +and you're good to go! + ## :book: License `rocks.nvim` is licensed under [GPLv3](./LICENSE).