From 66942e614c2930f02c278312fb5abed58a0bf7cf Mon Sep 17 00:00:00 2001 From: Daniel Maslowski Date: Tue, 21 May 2024 23:54:07 +0200 Subject: [PATCH] add README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..87831e9 --- /dev/null +++ b/README.md @@ -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. 🦀