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.

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

Ilariae/introduction wh #1

Merged
merged 12 commits into from
Jul 30, 2024
Merged
Binary file added .DS_Store
Binary file not shown.
Binary file added images/.DS_Store
Binary file not shown.
Binary file added images/learn/.DS_Store
Binary file not shown.
Binary file added images/learn/architecture/overview.webp
Binary file not shown.
Binary file added images/learn/introduction/simple-overview.webp
Binary file not shown.
70 changes: 70 additions & 0 deletions learn/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<!--
ilariae marked this conversation as resolved.
Show resolved Hide resolved
some links are blank because not all the pages are created yet
also missing the list of blockchains
the rest should be fine for now
-->
# Introduction to Wormhole

Wormhole is a generic **message-passing protocol** that enables communication between blockchains.
ilariae marked this conversation as resolved.
Show resolved Hide resolved

![Overview](/wormhole-mkdocs/images/learn/introduction/simple-overview.webp)
ilariae marked this conversation as resolved.
Show resolved Hide resolved

!!! note
The above is an oversimplified illustration of the protocol; details about the architecture and components are available in the **[architecture page](#){target=\_blank}**.
ilariae marked this conversation as resolved.
Show resolved Hide resolved


ilariae marked this conversation as resolved.
Show resolved Hide resolved
This simple message-passing protocol allows developers and users of cross-chain applications to leverage the advantages of multiple ecosystems.

## What Isn't Wormhole?

- **Wormhole is _not_ a blockchain** - it provides a means of communication between blockchains or rollups

- **Wormhole is _not_ a token bridge** - however, there are **[protocols built on Wormhole](https://portalbridge.com/#/transfer){target=\_blank}** that serve this purpose

## What Can Wormhole Be Used For?

Consider the following examples of potential applications enabled by Wormhole:

- **Cross-Chain Exchange** - using **[Wormhole Connect](#){target=\_blank}**, developers can build exchanges that allow deposits from any Wormhole-connected chain, significantly increasing liquidity access
- **Cross-Chain Governance** - NFT collections on different networks can use Wormhole to communicate votes cast on their respective chains to a designated "voting" chain for combined proposals
- **Cross-Chain Game** - games can be developed on a performant network like Solana, with rewards issued as NFTs on another network, such as Ethereum

## Get Started

### Quick Start Tutorials

Tutorials are available to get started quickly and explain the concepts involved.

- **[Quick Start - Off Chain](#){target=\_blank}** - integrate Wormhole Connect into a new or existing web UI
- **[Quick Start - On Chain](#){target=\_blank}** - send your first cross-chain message

More tutorials are available **[on github](https://github.com/wormhole-foundation/docs.wormhole.com/blob/main/docs/tutorials/quick-start/README.md){target=\_blank}**.
ilariae marked this conversation as resolved.
Show resolved Hide resolved

## Explore

Discover more about the Wormhole ecosystem, components, and protocols:

- **[Architecture](#){target=\_blank}** - explore the components of the protocol
- **[Protocol Specifications](https://github.com/wormhole-foundation/wormhole/tree/main/whitepapers){target=\_blank}** - learn about the protocols built on top of Wormhole

## Demos

Demos offer more realistic implementations than tutorials:

- **[Wormhole Scaffolding](https://github.com/wormhole-foundation/wormhole-scaffolding){target=\_blank}** - quickly set up a project with the Scaffolding repo
- **[xDapp Book Projects](https://github.com/wormhole-foundation/xdapp-book/tree/main/projects){target=\_blank}** - run and learn from example programs

More demos are available in the **[demos page](#){target=\_blank}**.

!!! note
## Wormhole Integration Complete?
ilariae marked this conversation as resolved.
Show resolved Hide resolved

Let us know so we can list your project in our ecosystem directory and introduce you to our global, multichain community!

**[Reach out now!](https://forms.clickup.com/45049775/f/1aytxf-10244/JKYWRUQ70AUI99F32Q){target=\_blank}**

## Supported Blockchains

Wormhole supports a growing number of blockchains.

<!-- List of Blockchains here -->
Loading