diff --git a/resources/schemas/README.md b/resources/schemas/README.md new file mode 100644 index 0000000..e277a59 --- /dev/null +++ b/resources/schemas/README.md @@ -0,0 +1,16 @@ +# Victory Card Schemas + +These schemas define how *Victory!* cards should be represented in JSON for interaction with the [cards database API](../../create/). + + +
+ + +## Casing + +Particular casing styles are used for different attributes. + +| key nature | case | instance | notes | +| :--------- | :--- | :------- | :---- | +| in-game properties | `Single` | `Power` `Materials` | Capitalised for visual distinction from other JSON Schema keys. | +| enum values | `KEBAB-CAPS` | `CYBERNETIC` `UPGRADE` | Fully capitalised for consistency while retaining visual distinction from other values. |