mirrors/vrc-get
2
0
Fork 0
mirror of https://github.com/vrc-get/vrc-get.git synced 2026-06-21 09:58:08 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(vpm-spec): add vrc-get.aliases

Browse source
This commit is contained in:
anatawa12 2024-05-27 20:52:02 +09:00
commit 2a790884e0
No known key found for this signature in database
GPG key ID: 9CA909848B8E4EA6
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/vpm-spec.md
View file

@ -267,6 +267,12 @@ The VPM Clients that recognizes the `yanked` field **SHOULD** show the warning
if the package is yanked and the package is already installed
and **MUST NOT** allow users to install the yanked package except for resolving the packages.
##### 4.2.A.2. `aliases` (array)
The `aliases` field of `vrc-get` shows the list of the alternative package display names.
The type of the `aliases` field **MUST** be an array of strings.
The VPM Client **MAY** use the `aliases` field to better package search
but this field **MUST NOT** affect the behavior of the VPM Client.
## 5. VPM Repository
The VPM Repository is a server that provides the package information and the package archive file.
The VPM Repository consists of the Package Information JSON file and the Package Archive file.