diff options
| author | William Boman <william@redwill.se> | 2023-03-26 15:19:55 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-26 13:19:55 +0000 |
| commit | dee830887857a002681026e99ddf5a32751abd19 (patch) | |
| tree | 931f528748c75428ef4635afd64302e0c5eb6f41 /README.md | |
| parent | docs: clarify installation location and add more help links (#1138) (diff) | |
| download | mason-dee830887857a002681026e99ddf5a32751abd19.tar mason-dee830887857a002681026e99ddf5a32751abd19.tar.gz mason-dee830887857a002681026e99ddf5a32751abd19.tar.bz2 mason-dee830887857a002681026e99ddf5a32751abd19.tar.lz mason-dee830887857a002681026e99ddf5a32751abd19.tar.xz mason-dee830887857a002681026e99ddf5a32751abd19.tar.zst mason-dee830887857a002681026e99ddf5a32751abd19.zip | |
docs: add Registries section to README (#1140)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -22,6 +22,7 @@ - [Setup](#setup) - [Extensions](#extensions) - [Commands](#commands) +- [Registries](#registries) - [Configuration](#configuration) # Introduction @@ -142,6 +143,17 @@ Refer to the [Wiki](https://github.com/williamboman/mason.nvim/wiki/Extensions) - `:MasonUninstallAll` - uninstalls all packages - `:MasonLog` - opens the `mason.nvim` log file in a new tab window + +# Registries + +Mason's core package registry is located at [mason-org/mason-registry](https://github.com/mason-org/mason-registry). +Before any packages can be used, the registry needs to be downloaded. This is done automatically for you when using the +different Mason commands (e.g. `:MasonInstall`), but can also be done manually by using the `:MasonUpdate` command. + +If you're utilizing Mason's Lua APIs to access packages, it's recommended to use the +[`:h mason-registry.refresh()`][help-mason-registry-refresh] and/or [`:h mason-registry.update()`][help-mason-registry-update] +functions to ensure you have the latest package information before retrieving packages. + # Configuration > [`:h mason-settings`][help-mason-settings] @@ -283,6 +295,8 @@ local DEFAULT_SETTINGS = { [help-mason-how-to-use-packages]: ./doc/mason.txt#L153 [help-mason-introduction]: ./doc/mason.txt#L11 [help-mason-quickstart]: ./doc/mason.txt#L67 +[help-mason-registry-refresh]: ./doc/mason.txt#L509 +[help-mason-registry-update]: ./doc/mason.txt#L502 [help-mason-requirements]: ./doc/mason.txt#L50 [help-mason-settings]: ./doc/mason.txt#L237 [help-standard-path]: https://neovim.io/doc/user/starting.html#standard-path |