From 453a41fb44b42efc68fba92c0674b09493aec846 Mon Sep 17 00:00:00 2001
From: Gabriel mermelstein <gabrielmermelstein@gmail.com>
Date: Fri, 29 Nov 2024 13:22:12 +0200
Subject: [PATCH] update readme

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7df7e2e..7f83b75 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-# waku-go-bindings
\ No newline at end of file
+# Waku Go Bindings
+
+This repository provides Go bindings for the Waku library, enabling seamless integration with Go projects.
+
+## Installation
+
+To build the required dependencies for this module, the `make` command needs to be executed. If you are integrating this module into another project via `go get`, ensure that you navigate to the `waku-go-bindings` module directory and run `make`.
+
+### Steps to Install
+
+Follow these steps to install and set up the module:
+
+1. Retrieve the module using `go get`:
+   ```
+   go get -u github.com/waku-org/waku-go-bindings@feat-go-bindings
+   ```
+2. Navigate to the module's directory:
+   ```
+   cd $(go list -m -f '{{.Dir}}' github.com/waku-org/waku-go-bindings)
+   ```
+3. Build the dependencies:
+   ```
+   sudo make
+   ```
+
+Now the module is ready for use in your project.