add README

This commit is contained in:
Daniel Maslowski 2024-05-21 23:54:07 +02:00
parent b9405a396f
commit 66942e614c

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# Chaospott Status
Because we RiiR, we have ported our space status API to Rust.
Thanks a lot to [axum the web app framework](https://github.com/tokio-rs/axum)
and the [spaceapi crate](https://crates.io/crates/spaceapi), the initial work
was a matter of a rainy evening. 🌧️🧑‍💻
The original code was written in PHP 🐘 by bandie.
## Development
Check out the [tutorial](https://www.youtube.com/watch?v=Vhh_GeBPOhs).
To start the app, just `cargo run --release` as usual.
Find scripts for testing in [`scripts/`](scripts/).
## Need help?
Ask chfkch, starblue, m0veax, CyReVolt or your favourite Rustacean. 🦀