Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: readme & license #11

Merged
merged 6 commits into from
Oct 21, 2024
Merged

docs: readme & license #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8541f79
docs: readme
failfmi Oct 21, 2024
051758e
docs(readme): comment tip & uncomment license
failfmi Oct 21, 2024
f7b4de3
docs(readme): renamings
failfmi Oct 21, 2024
2a5fd13
docs(readme): logo width
failfmi Oct 21, 2024
5600ce2
docs(readme): width logo
failfmi Oct 21, 2024
8abded4
license: puffer & taiko
failfmi Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/taiko-icon-blk.svg
View file
Open in desktop

This file was deleted.

Binary file added .github/unifi_logo_blue.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright 2023 Taiko Labs
Copyright 2024 Puffer Finance

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
9 changes: 9 additions & 0 deletions LICENSE_TAIKO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright 2023 Taiko Labs

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
64 changes: 31 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,63 +1,61 @@
<p align="center">
<img src="./.github/taiko-icon-blk.svg" width="80" alt="Logo for Taiko" />
<img src="./.github/unifi_logo_blue.png" width="150" alt="Logo for Puffer" />
</p>

<h1 align="center">
Taiko
Puffer | UniFi
</h1>

<p align="center">
A based rollup.
A Based Rollup Solution
</p>

<div align="center">

[![Twitter Follow](https://img.shields.io/twitter/follow/taikoxyz?style=social)](https://twitter.com/taikoxyz)
[![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/taikoxyz)
[![YouTube](https://img.shields.io/youtube/channel/subscribers/UCxd_ARE9LtAEdnRQA6g1TaQ)](https://www.youtube.com/@taikoxyz)
[![Twitter Follow](https://img.shields.io/twitter/follow/puffer_unifi?style=social)](https://twitter.com/puffer_unifi)
[![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/pufferfi)

[![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/taikoxyz/taiko-mono/badge)](https://www.gitpoap.io/gh/taikoxyz/taiko-mono)
[![License](https://img.shields.io/github/license/taikoxyz/taiko-mono)](https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md)
[![License](https://img.shields.io/github/license/pufferfinance/unifi-mono)](https://github.com/pufferfinance/unifi-mono/blob/unifi/LICENSE.md)

</div>

## Documentation

Get started with Taiko:
Get started with UniFi:

- [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.
- [UniFi docs](https://docs.puffer.fi/unifi-based-rollup/) — High-level concepts, guides, resources, and reference pages for getting started.
- [Protocol specs](./packages/protocol/docs/README.md) — In-depth specifications of the UniFi protocol for deeper understanding.
- [Smart contracts](./packages/protocol/contracts/) — UniFi protocol smart contracts, fully documented with NatSpec.

## Packages

> [!TIP]
> Make sure your node is using the latest version tags for taiko-client and taiko-geth. Check out the [node releases page](https://docs.taiko.xyz/network-reference/node-releases)!

| Package | Description | Release notes |
| :---------------------------------------------------------------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [bridge-ui](./packages/bridge-ui) | Bridge UI. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=bridge-ui*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/bridge-ui/CHANGELOG.md) |
| [docs-site](./packages/docs-site) | End user documentation site. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=docs-site*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/docs-site/CHANGELOG.md) |
| [eventindexer](./packages/eventindexer) | Event indexer. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=eventindexer*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/eventindexer/CHANGELOG.md) |
| [fork-diff](./packages/fork-diff) | Fork diff page. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=fork-diff*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/fork-diff/CHANGELOG.md) |
| [guardian-prover-health-check](./packages/guardian-prover-health-check) | Guardian prover health check service. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=guardian-prover-health-check*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/guardian-prover-health-check/CHANGELOG.md) |
| [guardian-prover-health-check-ui](./packages/guardian-prover-health-check-ui) | Guardian prover health check UI. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=guardian-prover-health-check-ui*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/guardian-prover-health-check-ui/CHANGELOG.md) |
| [protocol](./packages/protocol) | Taiko protocol smart contracts. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=protocol*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/CHANGELOG.md) |
| [relayer](./packages/relayer) | Bridge backend relayer. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=relayer*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/relayer/CHANGELOG.md) |
| [snaefell-ui](./packages/snaefell-ui) | Snaefell UI. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=snaefell-ui*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/snaefell-ui/CHANGELOG.md) |
| [supplementary-contracts](./packages/supplementary-contracts) | Supplementary contracts not part of the Taiko protocol. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=supplementary-contracts*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/supplementary-contracts/CHANGELOG.md) |
| [taiko-client](./packages/taiko-client) | Taiko client implementation in Go. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=taiko-client*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/taiko-client/CHANGELOG.md) |
| [taikoon-ui](./packages/taikoon-ui) | Taikoon UI. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=taikoon-ui*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/taikoon-ui/CHANGELOG.md) |
| [ui-lib](./packages/ui-lib) | UI library. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=ui-lib*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/ui-lib/CHANGELOG.md) |
[//]: # (> [!TIP])
[//]: # (> Make sure your node is using the latest version tags for unifi-client and unifi-geth.&#41;)

| Package | Description | Release notes |
|:------------------------------------------------------------------------------|:--------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [bridge-ui](./packages/bridge-ui) | Bridge UI. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=bridge-ui*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/bridge-ui/CHANGELOG.md) |
| [docs-site](./packages/docs-site) | End user documentation site. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=docs-site*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/docs-site/CHANGELOG.md) |
| [eventindexer](./packages/eventindexer) | Event indexer. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=eventindexer*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/eventindexer/CHANGELOG.md) |
| [fork-diff](./packages/fork-diff) | Fork diff page. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=fork-diff*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/fork-diff/CHANGELOG.md) |
| [guardian-prover-health-check](./packages/guardian-prover-health-check) | Guardian prover health check service. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=guardian-prover-health-check*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/guardian-prover-health-check/CHANGELOG.md) |
| [guardian-prover-health-check-ui](./packages/guardian-prover-health-check-ui) | Guardian prover health check UI. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=guardian-prover-health-check-ui*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/guardian-prover-health-check-ui/CHANGELOG.md) |
| [protocol](./packages/protocol) | UniFi protocol smart contracts. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=protocol*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/protocol/CHANGELOG.md) |
| [relayer](./packages/relayer) | Bridge backend relayer. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=relayer*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/relayer/CHANGELOG.md) |
| [snaefell-ui](./packages/snaefell-ui) | Snaefell UI. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=snaefell-ui*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/snaefell-ui/CHANGELOG.md) |
| [supplementary-contracts](./packages/supplementary-contracts) | Supplementary contracts not part of the UniFi protocol. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=supplementary-contracts*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/supplementary-contracts/CHANGELOG.md) |
| [taiko-client](./packages/taiko-client) | UniFi client implementation in Go. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=taiko-client*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/taiko-client/CHANGELOG.md) |
| [taikoon-ui](./packages/taikoon-ui) | Taikoon UI. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=taikoon-ui*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/taikoon-ui/CHANGELOG.md) |
| [ui-lib](./packages/ui-lib) | UI library. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=ui-lib*&label=)](https://github.com/pufferfinance/unifi-mono/blob/main/packages/ui-lib/CHANGELOG.md) |

## Issues

If you find a bug or have a feature request, please [open an issue](https://github.com/taikoxyz/taiko-mono/issues/new/choose).
If you find a bug or have a feature request, please [open an issue](https://github.com/pufferfinance/unifi-mono/issues/new/choose).

## Contributing

Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute. You can also check out our grants cycle at [grants.taiko.xyz](https://grants.taiko.xyz).
Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute.

## Getting support

Reach out to the community on [Discord](https://discord.gg/taikoxyz) if you need any help!
Reach out to the community on [Discord](https://discord.gg/pufferfi) if you need any help!
Loading
Loading