Add instructions

README.md

@@ -1,2 +1,32 @@
-# discourse-theme
-A custom Godot styled theme for discourse
+# Discourse Theme
+A Godot styled theme for discourse.
+
+
+## Development
+
+You can use the discourse theme CLI to automatically push changes to a live website.
+Please follow the instructions in the [official CLI documentation](https://meta.discourse.org/t/install-the-discourse-theme-cli-console-app-to-help-you-build-themes/82950).
+
+Once the CLI is installed, follow these steps as a one time setup:
+1. Go to [discourse.theme-creator.io/my/themes](https://discourse.theme-creator.io/my/themes)
+2. Select "Install" > "From a git repository" and enter `https://github.com/godotengine/discourse-theme`
+3. Select "Advanced" and then "Edit Locally"
+4. Generate and copy an API key (store it somewhere!)
+
+You can now see a live preview every time you want to work on the theme:
+1. On your local machine: open a terminal, navigate to the repository root directory and enter `discourse_theme watch .`
+  - if asked, enter the root url: `https://discourse.theme-creator.io/`
+  - if asked, enter the API key you retrieved in the one time setup
+  - you may answer `y` to store these, so that you don't need to enter them again
+  - select the theme "Godot" for synchronisation
+2. Go to [discourse.theme-creator.io/my/themes](https://discourse.theme-creator.io/my/themes) and select the theme you are editing
+3. Click on the "Preview" button
+
+
+## Usage
+
+To use this theme on a discourse instance, follow these steps:
+
+1. in discourse, go to Admin > Customize > Themes
+2. click the Install button and choose "From a git repository"
+3. Enter the URL of this repo: `https://github.com/godotengine/discourse-theme`