xdapp-book/README.md

1.0 KiB

⚠️ This project has been archived. please visit the Wormhole Docs

The xDapp Book

How to get started building cross chain applications with Wormhole

Documentation

The book is hosted at book.wormhole.com

Projects

You can find the projects used in the book in the projects directory.

Building the Book

To run on a Mac, install Homebrew if you don't already have it.

Then, run the following commands:

brew upgrade
brew install mdbook

Next, clone this repo and serve the book:

git clone https://github.com/wormhole-foundation/xdapp-book.git
cd xdapp-book
mdbook serve

The book will be available at http://localhost:3000 in your browser.

License

The xDapp Book is licensed under Apache 2.0.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in xDapp Book by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.