diff --git a/docs/index.md b/docs/index.md index 85fd061..04674b3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,19 @@ # Jumpstart V2: Electric Boogaloo -![image](./docs/images/jumpstart_transparant.png) +![image](./images/jumpstart_transparant.png) ![Static Badge](https://img.shields.io/badge/%40gravy-made_by?style=flat-square&logo=github&labelColor=%230d1117&color=%23E11C52&link=https%3A%2F%2Fgithub.com%2FNikolaiStrong) -A graphical interface that displays important information at the entrance of CSH. -This is a backend re-write of the previous jumpstart. +A graphical interface that displays information in the elevator lobby of Computer Science House. +All information displayed has been authorized to been shown. -See it live [here](https://jumpstart.csh.rit.edu)! +This project uses Python, [FastAPI](https://fastapi.tiangolo.com/), HTML/CSS, and Javascript. +See it live [here](http://jumpstart-squared.cs.house/)! + +## Installing +1. Clone and cd into the repo: git clone https://github.com/WeatherGod3218/jumpstartV2 +>> (OPTIONAL): Make another branch if your working on a large thing! ## Setup 1. Make sure you have docker installed