-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(readme): refactor badges and readme homepage (#427)
- Loading branch information
dave | d1onys1us
authored
Dec 14, 2022
1 parent
6253f5f
commit a81a052
Showing
4 changed files
with
55 additions
and
108 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,90 +1,62 @@ | ||
| <!-- BADGES --> | ||
| <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
| [](#contributors-) | ||
| <!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
| <p align="center"> | ||
| <img src="./packages/branding/Logo/SVG/Taiko_Logo_Fluo.svg" width="80" alt="Logo for Taiko" /> | ||
| </p> | ||
|
|
||
| <h1 align="center"> | ||
| TAIKO | ||
| </h1> | ||
|
|
||
| [](https://github.com/taikoxyz/taiko-mono/actions/workflows/solidity.yml) | ||
| [](https://codecov.io/gh/taikoxyz/taiko-mono) | ||
| <p align="center"> | ||
| A decentralized, Ethereum-equivalent ZK-Rollup. | ||
| <br /> | ||
| <a href="https://taiko.xyz" target="_blank"><strong>Explore the website</strong></a> | ||
| </p> | ||
|
|
||
| [](https://github.com/taikoxyz/taiko-mono/actions/workflows/golang.yml) | ||
| [](https://codecov.io/gh/taikoxyz/taiko-mono) | ||
| <div align="center"> | ||
|
|
||
| [](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) | ||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <div align="center"> | ||
| <img src="./packages/branding/Logo/SVG/Taiko_Logo_Fluo.svg" alt="Logo" width="80" height="80"> | ||
| [](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) | ||
|
|
||
| <h3>TAIKO</h3> | ||
| [](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) | ||
|
|
||
| <p> | ||
| A decentralized Ethereum-equivalent ZK-Rollup | ||
| <br /> | ||
| <a href="https://taiko.xyz" target="_blank"><strong>Explore the website »</strong></a> | ||
| <br /> | ||
| </p> | ||
| </div> | ||
|
|
||
| ## 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 | ||
|
|
||
| <pre> | ||
| taiko-mono | ||
| ├── <a href="./CONTRIBUTING.md">CONTRIBUTING.md</a> | ||
| ├── <a href="./LICENSE.md">LICENSE.md</a> | ||
| ├── <a href="./README.md">README.md</a> | ||
| ... | ||
| ├── <a href="./packages">packages</a> | ||
| │ ├── <a href="./packages/branding">branding</a>: Taiko branding materials | ||
| │ ├── <a href="./packages/bridge-frontend">bridge-frontend</a>: Bridge frontend UI | ||
| │ ├── <a href="./packages/bridge-ui">bridge-ui</a>: Bridge frontend UI | ||
| │ ├── <a href="./packages/protocol">protocol</a>: L1 and L2 protocol smart contracts | ||
| │ ├── <a href="./packages/relayer">relayer</a>: Bridge relayer | ||
| │ ├── <a href="./packages/website">website</a>: Main documentation website at taiko.xyz | ||
| │ └── <a href="./packages/whitepaper">whitepaper</a>: Whitepaper source files with automated publishing | ||
| ... | ||
| </pre> | ||
|
|
||
| ## 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)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/d1onys1us"><img src="https://avatars.githubusercontent.com/u/13951458?v=4?s=100" width="100px;" alt="d1onys1us"/><br /><sub><b>d1onys1us</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=d1onys1us" title="Documentation">📖</a></td> | ||
| <td align="center"><a href="https://github.com/davidtaikocha"><img src="https://avatars.githubusercontent.com/u/104078303?v=4?s=100" width="100px;" alt="David"/><br /><sub><b>David</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=davidtaikocha" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=davidtaikocha" title="Code">💻</a></td> | ||
| <td align="center"><a href="http://taiko.xyz"><img src="https://avatars.githubusercontent.com/u/99078276?v=4?s=100" width="100px;" alt="dantaik"/><br /><sub><b>dantaik</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=dantaik" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=dantaik" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/cyberhorsey"><img src="https://avatars.githubusercontent.com/u/113397187?v=4?s=100" width="100px;" alt="cyberhorsey"/><br /><sub><b>cyberhorsey</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=cyberhorsey" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=cyberhorsey" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/RogerLamTd"><img src="https://avatars.githubusercontent.com/u/50648015?v=4?s=100" width="100px;" alt="RogerLamTd"/><br /><sub><b>RogerLamTd</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=RogerLamTd" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=RogerLamTd" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/alexshliu"><img src="https://avatars.githubusercontent.com/u/104080237?v=4?s=100" width="100px;" alt="alexshliu"/><br /><sub><b>alexshliu</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=alexshliu" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=alexshliu" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/kirataik"><img src="https://avatars.githubusercontent.com/u/104244966?v=4?s=100" width="100px;" alt="kirataik"/><br /><sub><b>kirataik</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=kirataik" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=kirataik" title="Code">💻</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/mfinestone"><img src="https://avatars.githubusercontent.com/u/36642873?v=4?s=100" width="100px;" alt="mfinestone"/><br /><sub><b>mfinestone</b></sub></a><br /><a href="#business-mfinestone" title="Business development">💼</a> <a href="#content-mfinestone" title="Content">🖋</a></td> | ||
| <td align="center"><a href="https://github.com/shadab-taiko"><img src="https://avatars.githubusercontent.com/u/108871478?v=4?s=100" width="100px;" alt="shadab-taiko"/><br /><sub><b>shadab-taiko</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=shadab-taiko" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=shadab-taiko" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/1xDeFi"><img src="https://avatars.githubusercontent.com/u/90858998?v=4?s=100" width="100px;" alt="1xDeFi"/><br /><sub><b>1xDeFi</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=1xDeFi" title="Documentation">📖</a></td> | ||
| <td align="center"><a href="https://github.com/odesium"><img src="https://avatars.githubusercontent.com/u/56487762?v=4?s=100" width="100px;" alt="Ben"/><br /><sub><b>Ben</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=odesium" title="Documentation">📖</a></td> | ||
| <td align="center"><a href="https://github.com/omahs"><img src="https://avatars.githubusercontent.com/u/73983677?v=4?s=100" width="100px;" alt="omahs"/><br /><sub><b>omahs</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=omahs" title="Documentation">📖</a></td> | ||
| <td align="center"><a href="https://github.com/wolfderechter"><img src="https://avatars.githubusercontent.com/u/60930264?v=4?s=100" width="100px;" alt="wolfderechter"/><br /><sub><b>wolfderechter</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=wolfderechter" title="Code">💻</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=wolfderechter" title="Documentation">📖</a></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| 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). | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! | ||
| <a href="https://github.com/taikoxyz/taiko-mono/graphs/contributors"> | ||
| <p align="center"> | ||
| <img width="720" src="https://contrib.rocks/image?repo=taikoxyz/taiko-mono" /> | ||
| </p> | ||
| </a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters