Update README.md

This commit is contained in:
transatoshi_mw
2025-05-27 14:29:43 -07:00
committed by GitHub
parent 30c35202d9
commit 5c2eef16b3

View File

@@ -1,11 +1,11 @@
# grin_faucet
# grin-faucet
Grin faucet written in Rust with a vanilla HTML/CSS/JS frontend.
Grin faucet backend written in Rust.
It is meant to run on your Grin node, you will need to edit the wallet \<PASSWORD\> and URLs in main.rs.
It is meant to run on your Grin node, you will need to edit the wallet \<PASSWORD\>, \<DIRs\> and \<URLs\> in main.rs.
There is no front end or webserver included so you will need to serve an HTML/CSS/JS page with something like Nginx.
To run after changing parameters, simply clone the repository, cd in to it, and execute 'cargo run'. Your faucet will listen on port 3031. Check out the releases page for an executable.
To run after cloning and changing parameters, cd in to it, and execute 'cargo run'. Your faucet will listen on port 3031. Check out the releases page for an executable. To create your own executable run 'cargo build --release'.