From 3fcfa18d85a2a9ef6a44d2f4ac72f448f066b3a9 Mon Sep 17 00:00:00 2001 From: Anil Kumar <150643132+anil-rome@users.noreply.github.com> Date: Thu, 23 Jul 2026 19:47:41 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20README=20archetype=20fills=20=E2=80=94?= =?UTF-8?q?=20what-it-does=20table,=20run=20&=20test,=20license=20section?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fleet-audit fix: the flagship from-home app had no build/test/run section, no feature table, and nothing surfacing the NOTICE provenance. --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index b2dde27..3710f97 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,13 @@ Live at **https://appia.devnet.romeprotocol.xyz**. Built with Next.js 15, TypeSc In Rome's terms, Appia is the **"from home"** pattern: reach a Rome app from your home chain and get to Solana without moving. +| You can | Where it lands on Solana | +|---|---| +| Pay USDC from your L2 → buy + stake SOL | Marinade (mSOL position in **your** PDA) | +| Swap | Meteora DAMM, via Rome CPI | +| Lend | Mango | +| Recover / claim positions | your key, always — no custody surface | + ## What's in the repo ``` @@ -41,6 +48,21 @@ appia/ Nothing is hard-coded: chain id, RPC, program id, token mints, and bridge addresses all resolve from the public [`@rome-protocol/registry`](https://github.com/rome-protocol/rome-registry) via `scripts/build-chain-config.mts` into a committed `src/rome/chain-config.generated.json`. Point it at another Rome chain and rebuild. +## Run & test + +```bash +npm install +npm run build:chain-config # regenerate chain config from @rome-protocol/registry +npm run dev # http://localhost:4700 +npm test # vitest (resolver, encoders, guards) +npm run typecheck +npx playwright test # e2e journeys (e2e/) +``` + +## License + +Apache-2.0 — see [LICENSE](LICENSE). Appia is an original app; third-party protocol attributions (Marinade, Mango, Meteora, Wormhole, CCTP) are in [NOTICE](NOTICE). + ## Learn more - **[Rome Protocol documentation](https://docs.rome.builders)** — how EVM execution and CPI work inside Solana, and the four ways to build.