From 1fcc56027f9b75ef20fe9ca9f88bb4013697a293 Mon Sep 17 00:00:00 2001 From: julian-CStack <97684800+julian-CStack@users.noreply.github.com> Date: Fri, 12 May 2023 10:53:10 -0600 Subject: [PATCH] Update README.md add basic edit instructions --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 367b5b2..ffd0312 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,14 @@ This is the repository for the Stack Theme Selector Server. This server is used ## 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 +- 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) + +## Editing a theme +- Extract zip of theme and make any changes +- Create new archive +- Update [themes.json](data/themes.json) file