From 4d8cb5fd12039545aebceeb708f025721d47ed44 Mon Sep 17 00:00:00 2001
From: upong <efoucaud@ifotec.com>
Date: Tue, 4 Apr 2023 10:35:30 +0200
Subject: [PATCH] docs: add readme

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e81ecef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# SUI Faucet Claim
+
+*It is a bot written in goling which automatically claims your faucet every 6 hours.*
+
+## Setup
+
+### Requirements
+
+- [Golang](https://go.dev/doc/install)
+
+Copy the `.env.example` file and rename it to `.env`. Fill the variables with your own values.
+
+Don't forget to put `,` between the wallets.
+
+```env
+WALLET=wallet1,wallet2,etc
+```
+
+## Run
+
+### Run with go
+
+```bash
+go run .
+```
+
+### Build windows
+
+```bash
+GOOS=windows GOARCH=amd64 go build -o suifaucet.exe .
+```
+
+### Build linux
+
+```bash
+GOOS=linux GOARCH=amd64 go build -o suifaucet .
+```
+
+### Build mac
+
+```bash
+GOOS=darwin GOARCH=amd64 go build -o suifaucet .
+```