docs: add readme

This commit is contained in:
upong 2023-04-04 10:35:30 +02:00
parent baa0e2a40e
commit 4d8cb5fd12

43
README.md Normal file
View File

@ -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 .
```