Skip to content

Commit fd41d21

Browse files
committed
updating readme to suggest <vendor>-<version>.json format
1 parent f8f22c1 commit fd41d21

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Each year (e.g. competition season) has a JSON file at the root level (named `YE
1313
The root-level `YEAR.json` files (e.g. `2024.json`) provide the master directory of available vendor libraries. It's intended to be used by IDEs such as Visual Studio Code to present a user-friendly list of available vendor libraries.
1414

1515
This json file consists of a list of dicts with the following keys:
16-
* path: the path within the repository to the vendor JSON file (e.g. `2024/vendor.json`)
17-
* name: the same as the name in the vendor JSON file
16+
* path: the path within the repository to the vendor JSON file (e.g. `2024/<vendor>-<version>.json`)
17+
* name: the same as the name in the vendor JSON file (`<vendor>-<version>.json`)
1818
* uuid: the same as the uuid in the vendor JSON file
1919
* description: a user-friendly brief description of the library -- intended to be displayed to users in list format
2020
* website: URL of the vendor website (e.g. a site with documentation / tutorials / tools installers)

0 commit comments

Comments
 (0)