Skip to content

Commit

Permalink
docs: add usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mehalter committed Feb 4, 2025
1 parent 9d92465 commit b8d5faf
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,24 @@ A community driven package registry for <a href="https://github.com/williamboman
Refer to [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.

Compiled registry contents are available via [releases](https://github.com/mason-org/mason-registry/releases).

## Usage

To use this registry you simply need to add the string `"github:AstroNvim/mason-registry"` to the `registries` list of
the `mason.nvim` configuration that is passed to the `require("mason").setup()` function.

**Lazy.nvim**

```lua
return {
"williamboman/mason.nvim",
opts = {
registries = {
-- default Mason registry has highest priority
"github:mason-org/mason-registry",
-- Add the AstroNvim mason registry
"github:AstroNvim/mason-registry",
},
},
}
```

0 comments on commit b8d5faf

Please sign in to comment.