From 6850c4c9cb4a0bad8ee182004ddb9e45eca81ae7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Abel=20Fern=C3=A1ndez?=
 <44572727+abefernan@users.noreply.github.com>
Date: Tue, 15 Oct 2024 20:01:28 +0200
Subject: [PATCH] Add instructions

---
 README.md | 39 ++++++++++++---------------------------
 1 file changed, 12 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index c403366..653a087 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,21 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# CosmWasm Tracing UI
 
-## Getting Started
+## Run locally
 
-First, run the development server:
+This app expects a reachable [cosmwasm-tracing-api](https://github.com/confio/cosmwasm-tracing-api) node as the source of its tracing data.
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+### Setting up CosmWasm Tracing API
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+Follow [the instructions](https://github.com/confio/cosmwasm-tracing-api?tab=readme-ov-file#run_locally) on its repo's `README.md`.
 
-## Learn More
+### Running the UI
 
-To learn more about Next.js, take a look at the following resources:
+Copy the `.env.sample` in the root of this repo to a new `.env.local` file. There you will be able to configure the CosmWasm API URL.
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+Example `.env.local`:
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+```bash
+NEXT_PUBLIC_API_URL=http://localhost:4000/api/v1
+```
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Then you can start this Node app in dev mode or prod mode by running `npm run dev` or `npm run start`, respectively, after installing its dependencies with `npm install`.