-[](https://github.com/taikoxyz/taiko-mono/actions/workflows/typescript.yml)
-[](https://codecov.io/gh/taikoxyz/taiko-mono)
+[](https://twitter.com/taikoxyz)
+[](https://discord.gg/taikoxyz)
+[](https://www.gitpoap.io/gh/taikoxyz/taiko-mono)
-
-
-
-
+[](https://github.com/taikoxyz/taiko-mono/actions/workflows/solidity.yml)
+[](https://github.com/taikoxyz/taiko-mono/actions/workflows/golang.yml)
+[](https://github.com/taikoxyz/taiko-mono/actions/workflows/typescript.yml)
+[](https://github.com/taikoxyz/taiko-mono/actions/workflows/website.yml)
-
TAIKO
+[](https://app.codecov.io/gh/taikoxyz/taiko-mono/tree/main/packages/protocol)
+[](https://app.codecov.io/gh/taikoxyz/taiko-mono/tree/main/packages/relayer)
+[](https://app.codecov.io/gh/taikoxyz/taiko-mono/tree/main/packages/bridge-ui)
-
- A decentralized Ethereum-equivalent ZK-Rollup
-
- Explore the website »
-
-
+## Documentation
+
+Most documentation can be found on the website, at [taiko.xyz](https://taiko.xyz). There should also be a README in each package, as well as comments in the source code.
+
## Project structure
taiko-mono
├── CONTRIBUTING.md
+├── LICENSE.md
├── README.md
...
├── packages
│ ├── branding: Taiko branding materials
-│ ├── bridge-frontend: Bridge frontend UI
+│ ├── bridge-ui: Bridge frontend UI
│ ├── protocol: L1 and L2 protocol smart contracts
│ ├── relayer: Bridge relayer
│ ├── website: Main documentation website at taiko.xyz
@@ -45,46 +51,12 @@ taiko-mono
...
-## Contributing guide
-
-Refer to the [Contributing guide](./CONTRIBUTING.md) to contribute.
-
-## Github Actions
-
-Each commit will automatically trigger the GitHub Actions to run. If any commit message in your push or the HEAD commit of your PR contains the strings [skip ci], [ci skip], [no ci], [skip actions], or [actions skip] workflows triggered on the push or pull_request events will be skipped.
-
## Contributors ✨
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-
-
-
-
+Thanks goes to these wonderful people! If you would like to contribute, please read the [Contributing guide](./CONTRIBUTING.md). You can also reach out to the community on [Discord](https://discord.gg/taikoxyz).
-
-
-
-
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!
+
+
+ 
+
+
diff --git a/packages/bridge-ui/README.md b/packages/bridge-ui/README.md
index 4ef762ffec4..a71646f3aee 100644
--- a/packages/bridge-ui/README.md
+++ b/packages/bridge-ui/README.md
@@ -1,48 +1,9 @@
-# Svelte + TS + Vite
+# Bridge UI
-This template should help get you started developing with Svelte and TypeScript in Vite.
+## Installation
-## Recommended IDE Setup
+`pnpm install`
-[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
+## Usage
-## Need an official Svelte framework?
-
-Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
-
-## Technical considerations
-
-**Why use this over SvelteKit?**
-
-- It brings its own routing solution which might not be preferable for some users.
-- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
- `vite dev` and `vite build` wouldn't work in a SvelteKit environment, for example.
-
-This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
-
-Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
-
-**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
-
-Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
-
-**Why include `.vscode/extensions.json`?**
-
-Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
-
-**Why enable `allowJs` in the TS template?**
-
-While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
-
-**Why is HMR not preserving my local component state?**
-
-HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
-
-If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
-
-```ts
-// store.ts
-// An extremely simple external store
-import { writable } from 'svelte/store'
-export default writable(0)
-```
+`pnpm start`
diff --git a/packages/relayer/README.md b/packages/relayer/README.md
index 3ea49aa6af1..f12149044b5 100644
--- a/packages/relayer/README.md
+++ b/packages/relayer/README.md
@@ -1,8 +1,11 @@
-# relayer
+[](https://github.com/taikoxyz/taiko-mono/actions/workflows/golang.yml)
+[](https://codecov.io/gh/taikoxyz/taiko-mono)
+
+# Relayer
A relayer for the Bridge to watch and sync event between Layer 1 and Taiko Layer 2.
-## Layout
+## Project structure
### bin
