Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seiyria committed Apr 18, 2024
1 parent 4cc97d5 commit c5da744
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,24 @@ This repository obtains and reformats cards for the Leder Spotlight application.
- `npm run build:i18n` - build the i18n files and ensure that they're formatted correctly
- `npm run validate:card-data` - validate the card data is formatted correctly

## Adding New Content

### Products

1. Create a new file matching the product name in `content/meta-data`
1. Create a new folder in `content/card-data` (the name should match the `productName` in the `meta-data` file)
1. Create a new folder in `content/card-images` (the name should match the `productName` in the `meta-data` file)
1. Create a new folder in `content/card-symbols` (the name should match the `productName` in the `meta-data` file)

Follow the guide for adding a new locale

### Locale

1. Create a new folder in `content/card-data/{product}` for the locale (probably `en-US`)
1. Add a `cards.yml` file here (or, as many separate files as desired - they all get concatenated together) and fill it with card data.
1. Create a new folder in `content/card-images/{product}` for the locale (probably `en-US`)
1. Fill this folder with the images for the cards for the game.

## Publishing New Content

This is done automatically when a PR is merged to `main`, and isn't intended to be done manually.

0 comments on commit c5da744

Please sign in to comment.