Update README.md

added basic instructions to create a theme
This commit is contained in:
julian-CStack 2023-05-12 10:44:31 -06:00 committed by GitHub
parent 89d502efc0
commit 10fb7f28a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,3 +1,12 @@
# Stack-Theme-Selector-Server
This is the repository for the Stack Theme Selector Server. This server is used to provide the theme selector for the Stack Wallet.
## Creating a theme (WIP)
- theme id must be unique
- theme zip file name must be the theme id
- the [themes.json](data/themes.json) file must be updated with (at least) the theme id and the sha256 hash of the zip file
- The `previewImageUrl` should point to an image located in [data/previews](data/previews)
- The preview image should match the preview image in the theme zip file
- See the current [Model](https://github.com/cypherstack/stack_wallet/blob/themes/lib/models/isar/stack_theme.dart) for minimum theme requirements (subject to change)