From 9a7feb409c0950b20758805bdc1d7f8f87176099 Mon Sep 17 00:00:00 2001
From: Alex <1221721+atcol@users.noreply.github.com>
Date: Sat, 30 Dec 2023 09:56:16 +0000
Subject: [PATCH] docs: basic project explanation

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eea81aa..005ba36 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
+[![Build legacy Nix package on Ubuntu](https://github.com/atcol/pingy/actions/workflows/build_nix.yml/badge.svg)](https://github.com/atcol/pingy/actions/workflows/build_nix.yml)
+
 # pingy
-A fast &amp; simple website monitor running in Shuttle
+A fast &amp; simple website monitor running in [Shuttle](https://shuttle.rs).
+
+## Development
+
+### Setup
+
+Make sure you've set up your Shuttle project as-per [Shuttle's quick-start guide](https://docs.shuttle.rs/getting-started/quick-start).
+
+This project uses Nix. To begin development you can:
+
+```bash
+$ nix develop
+```
+
+## Deploying
+
+```bash
+$ cargo shuttle deploy
+```