Skip to content

Commit

Permalink
docs(readme): add links to rocks-git and rocks-config modules (#89)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcjkb authored Dec 17, 2023
1 parent ba2d8d5 commit 26f6357
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit 26f6357

Please sign in to comment.