1 files changed, 24 insertions, 0 deletions
diff --git a/packages/bank-ui/README.md b/packages/bank-ui/README.md
new file mode 100644
index 000000000..4275cce57
--- /dev/null
+++ b/packages/bank-ui/README.md
@@ -0,0 +1,24 @@
+# Taler Bank UI
+
+Web-based user interface for the libeufin bank ui.
+
+## CLI Commands
+
+- `./dev.mjs` development setup. Will listen in :8080 and reload every time a file is save.
+- `./build.mjs` build for production.
+- `./test.mjs` build and run unit test
+
+## Testing
+
+By default, the bank-ui will expect the backend to be in `window.origin` but that can be overridden using the `settings.json` file or by session in the localStorage.
+
+```
+localStorage.setItem("bank-base-url", OTHER_URL);
+```
+
+## Customizing Per-Deployment Settings
+
+To customize per-deployment settings, make sure that the
+`settings.json` file is served alongside the UI.
+
+For more information about the values check the file `settings.ts` in the src folder.