Skip to content

Commit 37d5031

Browse files
committed
chore: Added Acknowledgement and donation section to README.md
1 parent 7d91c8d commit 37d5031

File tree

1 file changed

+43
-16
lines changed

1 file changed

+43
-16
lines changed

README.md

Lines changed: 43 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,22 @@ To build the executable binaries, you need:
3737
### Server requirements
3838

3939
- MySQL/MariaDB
40-
- [GeoIP Database][geoip_doc] (optional). Place it to `./assets/geoip`,
40+
- [GeoIP Database][geoip-doc] (optional). Place it to `./assets/geoip`,
4141
see [./internal/ip/geo/geoip.go](./internal/ip/geo/geoip.go).
4242

4343
## Installation
4444

4545
### For initial server setup:
4646

47-
1. Download [GeoIP Database][geoip_doc] and place it to `./assets/geoip`.
47+
1. Download [GeoIP Database][geoip-doc] and place it to `./assets/geoip`.
4848
(see [./internal/ip/geo/geoip.go](./internal/ip/geo/geoip.go)).
4949
2. Pepare your MySQL/MariaDB.
5050
3. Copy `.env.example` to `.env` and edit it to match with server environment.
5151
4. Build the binary with `make server` (or `make build` to build both
5252
**server** and **client** binaries).
5353
5. Run the service with `./bin/xmr-nodes-server-linux-<YOUR_CPU_ARCH> serve`.
5454

55-
Systemd example: [xmr-nodes-server.service][server_systemd_service].
55+
Systemd example: [xmr-nodes-server.service][server-systemd-service].
5656

5757
### For initial prober setup:
5858

@@ -62,31 +62,58 @@ Systemd example: [xmr-nodes-server.service][server_systemd_service].
6262
**server** and **client** binaries).
6363
4. Run the service with `./bin/xmr-nodes-client-linux-<YOUR_CPU_ARCH> probe`.
6464

65-
Systemd example: [xmr-nodes-prober.service][prober_systemd_service] and
66-
[xmr-nodes-prober.timer][prober_systemd_timer].
65+
Systemd example: [xmr-nodes-prober.service][prober-systemd-service] and
66+
[xmr-nodes-prober.timer][prober-systemd-timer].
6767

6868
## Development and Deployment
6969

7070
See the [Makefile](./Makefile).
7171

7272
## ToDo's
7373

74-
- Accept IPv6 nodes.
75-
- Use `a-h/templ` and `HTMX` instead of `Svelte`.
76-
- Use Go standard `net/http` instead of `fiber`.
74+
- :heavy_check_mark: Accept IPv6 nodes.
75+
- :white_check_mark: Use `a-h/templ` and `HTMX` instead of `Svelte`.
76+
- :white_check_mark: Use Go standard `net/http` instead of `fiber`.
77+
78+
## Acknowledgement
79+
80+
The creators and contributors of these projects have provided valuable
81+
resources, which I am grateful for:
82+
83+
- [jtgrassie/monero-pool][jtgrassie-monero-pool]
84+
- [rclone/rclone][rclone]
7785

7886
## Similar Projects
7987

80-
- [lalanza808/monero.fail][monerofail_gh]
81-
- [cake-tech/upptime-monerocom][uptime_monerocom_gh]
88+
- [lalanza808/monero.fail][monerofail-repo]
89+
- [cake-tech/upptime-monerocom][uptime-monerocom-repo]
90+
91+
## Donation
92+
93+
The servers costs are currently covered by myself. If you find this project
94+
useful, please consider making a donation to help cover the ongoing expenses.
95+
Your contribution will go towards ensuring the continued availability of the
96+
website and **my** `stagenet` and `testnet` public remote nodes.
97+
98+
XMR Donation address:
99+
100+
```plain
101+
8BWYe6GzbNKbxe3D8mPkfFMQA2rViaZJFhWShhZTjJCNG6EZHkXRZCKHiuKmwwe4DXDYF8KKcbGkvNYaiRG3sNt7JhnVp7D
102+
```
103+
104+
![][./frontend/static/img/monerotip.png]
105+
106+
Thank you!
82107

83108
## License
84109

85110
This project is licensed under [GLWTPL](./LICENSE).
86111

87-
[geoip_doc]: https://dev.maxmind.com/geoip/geoip2/geolite2/ "GeoIP documentation"
88-
[server_systemd_service]: ./deployment/init/xmr-nodes-server.service "systemd service example for server"
89-
[prober_systemd_service]: ./deployment/init/xmr-nodes-prober.service "systemd service example for prober"
90-
[prober_systemd_timer]: ./deployment/init/xmr-nodes-prober.timer "systemd timer example for prober"
91-
[monerofail_gh]: https://github.com/lalanza808/monero.fail "Lalanza808's monero.fail GitHub repository"
92-
[uptime_monerocom_gh]: https://github.com/cake-tech/upptime-monerocom "monero.com uptime GitHub repository"
112+
[geoip-doc]: https://dev.maxmind.com/geoip/geoip2/geolite2/ "GeoIP documentation"
113+
[server-systemd-service]: ./deployment/init/xmr-nodes-server.service "systemd service example for server"
114+
[prober-systemd-service]: ./deployment/init/xmr-nodes-prober.service "systemd service example for prober"
115+
[prober-systemd-timer]: ./deployment/init/xmr-nodes-prober.timer "systemd timer example for prober"
116+
[jtgrassie-monero-pool]: https://github.com/jtgrassie/monero-pool "A Monero mining pool server written in C"
117+
[rclone]: https://github.com/rclone/rclone "rclone GitHub repository"
118+
[monerofail-repo]: https://github.com/lalanza808/monero.fail "Lalanza808's monero.fail GitHub repository"
119+
[uptime-monerocom-repo]: https://github.com/cake-tech/upptime-monerocom "monero.com uptime GitHub repository"

0 commit comments

Comments
 (0)