From 76068004a6f0232fe1754fc3ff70a260b308268b Mon Sep 17 00:00:00 2001
From: Seun Lanlege <seun@polytope.technology>
Date: Sat, 20 Jan 2024 21:52:55 +0000
Subject: [PATCH] bump readme

---
 README.md | 107 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 106 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5c0c717c..c04493ca 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,110 @@
 # Hyperbridge
-Hyperbridge is a hyper-scalable, interoperability coprocessor.
+Hyperbridge is a hyper-scalable coprocessor for cryptographically secure, cross-chain interoperability.
+
+## Docker
+
+Hyperbridge is available at the official docker repository [`polytopelabs/hyperbridge`](https://hub.docker.com/r/polytopelabs/hyperbridge)
+
+```bash
+docker run polytopelabs/hyperbridge:latest --chain=messier
+```
+
+## Prebuilt Binaries
+
+You can install a prebuilt binary for the hyperbridge node with the following bash script
+
+```bash
+wget -q --show-progress https://github.com/polytope-labs/hyperbridge/releases/download/${latest-tag}/hyperbridge-x86_64-unknown-linux-gnu.tar.gz
+tar -xvzf hyperbridge-x86_64-unknown-linux-gnu.tar.gz
+# copy to $PATH
+cp hyperbridge-x86_64-unknown-linux-gnu/hyperbridge $HOME/.local/bin/
+```
+
+or a 1-liner shell script
+
+```bash
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/polytope-labs/hyperbridge/releases/download/${latest-tag}/hyperbridge-installer.sh | sh
+```
+
+## Building from source
+
+You can follow the steps below if you'd prefer to build the hyperbridge node from source:
+
+
+### Install Dependencies
+
+Building the hyperbridge node requires some dependencies
+
+- git
+- clang
+- curl
+- make
+- build-essential
+- libssl-dev
+- llvm
+- libudev-dev
+- protobuf-compiler
+
+Debian/Ubuntu
+
+```bash 
+sudo apt install --assume-yes git clang curl libssl-dev llvm libudev-dev make protobuf-compiler
+```
+Arch
+
+```bash
+pacman -Syu --needed --noconfirm curl git clang make protobuf
+```
+Fedora
+
+```bash
+sudo dnf update
+sudo dnf install clang curl git openssl-devel make protobuf-compiler
+```
+Opensuse
+
+```bash
+sudo zypper install clang curl git openssl-devel llvm-devel libudev-devel make protobuf
+```
+
+### Install rust compiler
+
+If you don't have an already existing rust installation, you can install it using the one-liner below. Follow the prompts displayed to proceed with a default installation.
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+### Install WebAssembly target
+
+Hyperbridge's blockchain runtime compiles to wasm which allows it's code to be forklessly upgraded. In order to build hyperbridge we need the wasm toolchain installed.
+
+```bash
+rustup update nightly
+rustup target add wasm32-unknown-unknown --toolchain nightly
+```
+
+### Clone the repo
+
+Download a local copy of the repo and checkout the latest release tag
+
+```bash
+git clone https://github.com/polytope-labs/hyperbridge.git
+cd ./hyperbidge
+git checkout ${latest-tag}
+```
+
+### Build the node
+
+```bash
+cargo build --release -p hyperbridge
+```
+
+## Running the node
+
+```bash
+hyperbridge --chain=messier --enable-offchain-indexing --base-path=$HOME/.hyperbridge --pruning-archive
+```
 
 ## Running a local tesnet with zombienet
 1. Download the zombienet binary for your os from https://github.com/paritytech/zombienet