From 10fb7f28a8237f5f18a540928f71bb584d9fd4b2 Mon Sep 17 00:00:00 2001 From: julian-CStack <97684800+julian-CStack@users.noreply.github.com> Date: Fri, 12 May 2023 10:44:31 -0600 Subject: [PATCH] Update README.md added basic instructions to create a theme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee2f9d4..367b5b2 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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)