diff --git a/README.md b/README.md index 9206f25..698e864 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,56 @@ -# Python Flask Webserver Template +# Fire HSD - Public Handshake API -Python3 website template including git actions +A Python Flask webserver providing a free public API for the [Handshake](https://handshake.org/) blockchain. -# Development -1. Install requirements -```bash -python3 -m pip install -r requirements.txt +## Features + +- Query blocks, headers, transactions, coins, and names from a public HSD node +- No authentication required for read-only endpoints +- Fast, simple, and open source ([AGPLv3](./LICENSE)) + +## Quick Start + +1. **Install requirements** + ```bash + python3 -m pip install -r requirements.txt + ``` +2. **Run the dev server** + ```bash + python3 server.py + ``` +3. **Production (Gunicorn)** + ```bash + python3 main.py + ``` + +## API Endpoints + +Some examples: +- `/api/v1/status` — Check HSD node status +- `/api/v1/block/` — Get block data by block id +- `/api/v1/header/` — Get header data by block id +- `/api/v1/tx/` — Get transaction info +- `/api/v1/name/` — Get name info +- `/api/v1/help` — List all API endpoints + +## Configuration + +Set environment variables in `.env` or use `example.env`: ``` -2. Run the dev server -```bash -python3 server.py +HSD_HOST=127.0.0.1 +HSD_API_KEY=APIKEY ``` -# Production -Run using the main.py file -```bash -python3 main.py -``` \ No newline at end of file +## Support & Donations + +If you'd like to help keep the service running and growing, consider donating: + +- [PayPal](https://paypal.me/nathanwoodburn) +- [Card (Stripe)](https://donate.stripe.com/8wM6pv0VD08Xe408ww) +- [HNS, BTC, or other](https://nathan.woodburn.au/donate) + +## License + +[GNU AGPLv3](./LICENSE) + +© 2025 Nathan Woodburn \ No newline at end of file diff --git a/templates/index.html b/templates/index.html index 08bb154..db86d81 100644 --- a/templates/index.html +++ b/templates/index.html @@ -80,8 +80,8 @@