From d9407d8056f3b13d92ab763c20a050ab6af4884b Mon Sep 17 00:00:00 2001 From: edbourque0 <69908386+edbourque0@users.noreply.github.com> Date: Tue, 16 Apr 2024 00:01:21 -0400 Subject: [PATCH] Update README.md --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 51 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fc84ecd..d41132c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -# clashstats -Clash Royale Statistics + +# 🏰 Clashstats + +A Django web app to get Clash Royale player info, battlelog and a clan ranking based on the ELO ranking system. + +**Note that I am a beginner with Python and programing in general. This is one of my first projects, so some features may not be built efficiently.** + + + + + +## 💻 Run Locally + +Clone the project + +```bash + git clone https://github.com/edbourque0/clashstats.git +``` + +Go to the clashstats directory + +```bash + cd clashstats +``` + +Install dependencies + +```bash + pip install -r requirements.txt +``` + +Start the server + +```bash + python3 manage.py runserver +``` + + +## 📟 Tech Stack + +**Languages:** Python, HTML + +**CSS components:** Bootstrap + +**Framework:** Django + + +## ✍️ Authors + +- [@edbourque0](https://www.github.com/edbourque0) +