From a01d02ad7f680aec98a1e2ec35b04cedd307cfa8 Mon Sep 17 00:00:00 2001
From: William Boman <william@redwill.se>
Date: Sun, 12 Mar 2023 08:21:15 +0100
Subject: feat: add github registry source capabilities (#1091)

---
 doc/reference.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

(limited to 'doc/reference.md')

diff --git a/doc/reference.md b/doc/reference.md
index e51ba57e..ba121423 100644
--- a/doc/reference.md
+++ b/doc/reference.md
@@ -26,6 +26,7 @@ RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as de
 -   [Architecture diagram](#architecture-diagram)
 -   [Registry events](#registry-events)
 -   [`PackageSpec`](#packagespec)
+-   [`RegistryPackageSpec`](#registrypackagespec)
 -   [`Package`](#package)
     -   [`Package.Parse({package_identifier})`](#packageparsepackage_identifier)
     -   [`Package.Lang`](#packagelang)
@@ -65,7 +66,9 @@ RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as de
 
 ## Architecture diagram
 
-![architecture](https://user-images.githubusercontent.com/6705160/179120955-2f093b80-4a4e-4201-8c7a-26adfa508cdf.png)
+<!-- https://excalidraw.com/#json=vbTmp7nM8H5odJDiaw7Ue,TghucvHHAw8bl7sgX1VuvA -->
+
+![architecture](https://user-images.githubusercontent.com/6705160/224515490-de6381f4-d0c0-40e6-82a0-89f95d08e865.png)
 
 ## Registry events
 
@@ -107,10 +110,26 @@ registry:on(
 | name       | `string`                             |
 | desc       | `string`                             |
 | homepage   | `string`                             |
-| categories | [`PackageCategory[]`](#package-cat)  |
-| languages  | [`PackageLanguage[]`](#package-lang) |
+| categories | [`PackageCategory[]`](#packagecat)  |
+| languages  | [`PackageLanguage[]`](#packagelang) |
 | install    | `async fun(ctx: InstallContext)`     |
 
+## `RegistryPackageSpec`
+
+| Key         | Value                                |
+| ----------- | ------------------------------------ |
+| schema      | `"registry+v1"`                      |
+| name        | `string`                             |
+| description | `string`                             |
+| homepage    | `string`                             |
+| licenses    | `string`                             |
+| categories  | [`PackageCategory[]`](#packagecat)  |
+| languages   | [`PackageLanguage[]`](#packagelang) |
+| source      | `table`                              |
+| bin         | `table<string, string>?`             |
+| share       | `table<string, string>?`             |
+| opt         | `table<string, string>?`             |
+
 ## `Package`
 
 Module: [`"mason-core.package"`](../lua/mason-core/package/init.lua)
@@ -175,7 +194,7 @@ All the available categories a package can be tagged with.
 
 ### `Package.spec`
 
-**Type**: [`PackageSpec`](#packagespec)
+**Type**: [`PackageSpec`](#packagespec) or [`RegistryPackageSpec`](#registrypackagespec)
 
 ### `Package:install({opts})`
 
-- 
cgit v1.2.3-70-g09d2