From 1b9498a13a3ee4718ad1052562b0da8d87b65d1d Mon Sep 17 00:00:00 2001
From: KenwoodFox <31870999+KenwoodFox@users.noreply.github.com>
Date: Sun, 5 Jan 2025 22:30:52 -0500
Subject: [PATCH] Update readme with instructions

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index e69de29..749cc12 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,31 @@
+[![ProjectHUD CI](https://github.com/FRC-1721/ProjectHud/actions/workflows/build_docker.yml/badge.svg)](https://github.com/FRC-1721/ProjectHud/actions/workflows/build_docker.yml)
+
+# Project Hud
+
+Flask server for displaying a quick development HUD (built specifically for use with FRC1721's code environment.
+
+![image](https://github.com/user-attachments/assets/4e62c869-bbb0-4391-9818-1196055490b4)
+
+## Development
+
+```shell
+pipenv shell
+flask run --debug
+```
+
+## Deploy
+
+Deployment is handled with docker.
+
+```yaml
+# Example Docker Compose File
+
+services:
+  project_hud:
+    image: ghcr.io/frc-1721/project_hud-bot:main
+    environment:
+      TZ: America/New_York
+      GITHUB_TOKEN: YOUR_TOKEN
+      GITHUB_REPOS: YOUR,REPOS
+```
+