From 8d2cca11180bd615420e9bb3287f31a9ddf18df8 Mon Sep 17 00:00:00 2001 From: Daniel Wang <99078276+dantaik@users.noreply.github.com> Date: Fri, 27 Dec 2024 10:26:44 +0800 Subject: [PATCH] docs(repo): update `README` (#18650) Co-authored-by: dionysuz <13951458+dionysuzx@users.noreply.github.com> --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ff647347278..8ba1fea61f9 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@

- Taiko + Taiko Alethia

- A based rollup. + The first based rollup.

@@ -23,11 +23,11 @@ ## Documentation -Get started with Taiko: +Get started with Taiko Alethia: -- [Taiko docs](https://docs.taiko.xyz) — High-level concepts, guides, resources, and reference pages for getting started. -- [Protocol specs](./packages/protocol/docs/README.md) — In-depth specifications of the Taiko protocol for deeper understanding. -- [Smart contracts](./packages/protocol/contracts/) — Taiko protocol smart contracts, fully documented with NatSpec. +- [Taiko Alethia docs](https://docs.taiko.xyz) — High-level concepts, guides, resources, and reference pages for getting started. +- [Protocol specs](./packages/protocol/docs/README.md) — In-depth specifications of the Taiko Alethia protocol for deeper understanding. +- [Smart contracts](./packages/protocol/contracts/) — Taiko Alethia protocol smart contracts, fully documented with NatSpec. ## Packages @@ -47,11 +47,11 @@ Get started with Taiko: | [guardian-prover-health-check-ui](./packages/guardian-prover-health-check-ui) | Guardian prover health check UI. | | [monitors](./packages/monitors) | Monitoring and alerting services. | | [nfts](./packages/nfts) | NFT-related smart contracts and utilities. | -| [protocol](./packages/protocol) | Taiko protocol smart contracts. | +| [protocol](./packages/protocol) | Taiko Alethia protocol smart contracts. | | [relayer](./packages/relayer) | Bridge backend relayer. | | [snaefell-ui](./packages/snaefell-ui) | Snaefell UI. | -| [supplementary-contracts](./packages/supplementary-contracts) | Supplementary contracts not part of the Taiko protocol. | -| [taiko-client](./packages/taiko-client) | Taiko client implementation in Go. | +| [supplementary-contracts](./packages/supplementary-contracts) | Supplementary contracts not part of the Taiko Alethia protocol. | +| [taiko-client](./packages/taiko-client) | Taiko Alethia client implementation in Go. | | [taikoon-ui](./packages/taikoon-ui) | Taikoon UI. | | [ui-lib](./packages/ui-lib) | UI library. |