Docs: add more info about custom themes in Gateway (#464)

This commit is contained in:
Michał Leszczyński
2025-06-23 17:34:31 +02:00
committed by GitHub
parent 2933dd1f35
commit 58c42a6920

View File

@@ -18,7 +18,7 @@
./themes/example/lennyface.png
./themes/example/style.css
```
4. Copy the `themes/example` directory as `themes/<your-theme-name>` and edit it.
4. Copy the `themes/example` directory as `themes/your_theme_name` and edit it.
## Testing your theme
@@ -29,7 +29,7 @@
|----------------------------------------------------|----------------------------|
| Override the default gateway URL | `ws://127.0.0.1:32842` |
| Override the default URL in QR code | `http://127.0.0.1:32842/e` |
| Override theme name | `your-theme-name` |
| Override theme name | `your_theme_name` |
| How would you like to sign the message | _(whatever)_ |
| Hex-encoded message to be signed with ECDSA/Keccak | _(whatever)_ |
@@ -38,3 +38,13 @@
## Deploying your theme to public Arx HaLo Gateway servers
Feel free to create a Pull Request on [arx-research/halo-gateway-themes](https://github.com/arx-research/halo-gateway-themes) repository.
## Using your theme
Pass the `themeName` option when constructing `HaloGateway` object to instruct which theme should be used.
```
let gate = new HaloGateway('wss://s1.halo-gateway.arx.org', {
themeName: "your_theme_name"
});
```