Skip to content

Commit ed90aa3

Browse files
committed
move configs to folder, update docs
1 parent 1cbd965 commit ed90aa3

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
11
# Cosmos Faucet
22

3-
GET some funds via a GET request :D
3+
Get funds through a browser GET request or cURL, making it easy for users without needing a discord bot. Configuration files allow adding multiple chain and mnemonic options for various network faucets.
44

5-
## Install
5+
## Usage
66

77
```bash
8+
# NODE: add chain ids in the chains.json file (can run multiple faucets on 1 instance)
9+
10+
# Show which chains and endpoints there are
11+
GET https://ip:port/
12+
13+
# Get information about the faucet for a given chain
14+
GET https://ip:port/<chain_id>
15+
16+
# Send funds to an address on the given chain
17+
GET https://ip:port/<chain_id>/<address>
18+
```
819

20+
## Install
21+
22+
```bash
923
sudo apt update
1024

1125
# install nodejs
@@ -23,10 +37,10 @@ sudo apt remove nodejs npm node nodejs-doc
2337
```
2438

2539
```bash
26-
cp .env.example .env
40+
cp configs/.env.example .env
2741
# edit the port you want it to run on
2842

29-
cp chains.json.example chains.json
43+
cp configs/chains.json.example chains.json
3044
# add chains / mnemonics you want to use. On start, you can view addresses via http://ip:port/<chain_id>
3145

3246
# local
@@ -37,4 +51,4 @@ npm i pm2 --global
3751
pm2 start src/index.ts --name faucet --watch --interpreter ./node_modules/.bin/ts-node
3852
# pm2 logs
3953
# pm2 stop faucet
40-
```
54+
```
File renamed without changes.

0 commit comments

Comments
 (0)