From 68edd99600fd4cb1386e3b9384b6cc0e704094d6 Mon Sep 17 00:00:00 2001
From: Bryan Chen <xlchen1291@gmail.com>
Date: Fri, 8 Nov 2024 10:17:16 +1300
Subject: [PATCH] update readme

---
 Cargo.toml |  1 -
 README.md  | 27 ++++++++++++++++++++++++++-
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index cbebb91..d571d3c 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -11,7 +11,6 @@ path = "src/main.rs"
 [dependencies]
 color-eyre = { version = "0.6.3", default-features = false }
 
-# TODO: update to a released version once available
 polkadot-parachain-lib = { git = "https://github.com/paritytech/polkadot-sdk", branch = "stable2409" }
 sc-chain-spec = { git = "https://github.com/paritytech/polkadot-sdk", branch = "stable2409" }
 sc-cli = { git = "https://github.com/paritytech/polkadot-sdk", branch = "stable2409" }
diff --git a/README.md b/README.md
index f9831c8..69e80f1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
 # acala-node
-The client node for Acala &amp; Karura parachain
+
+This is the client node for Acala and Karura. For runtime code, please refer to [Acala repo](https://github.com/AcalaNetwork/Acala).
+
+# Building
+
+```bash
+curl https://sh.rustup.rs -sSf | sh
+```
+
+You may need additional dependencies, checkout [substrate.io](https://docs.substrate.io/v3/getting-started/installation) for more info
+
+```bash
+sudo apt-get install -y git clang curl make libssl-dev llvm libudev-dev protobuf-compiler
+```
+
+Debug build:
+
+```bash
+cargo build
+```
+
+Release build:
+
+```bash
+cargo build --release
+```