Merge pull request #4 from lennonay/readme

Readme

README.md

@@ -1 +1,16 @@
-# WHL_prospect_stat
+# WHL_prospect_stat
+
+Author: Lennon Au-Yeung
+
+This project is created for the UBC Men's Hockey Analytics and Scouting team.
+
+## About
+This project aims to provide players statistics on potential recruits from the WHL for the UBC Men's Hockey team. All data collected in this project is from the official WHL website, the link can be find [here](https://whl.ca/).
+
+## Functions
+
+`roster.py`: Collects birth dates and birth years of all active WHL players from every team. The purpose is to identify overage players that are currently playing in the WHL, which are our primary recruit targets.
+
+`scraper.py`: Collects game data from the WHL 2022-2023 regular season, and processing into variables such as goals, primary assists and secondary assists for situations including even-strength, powerplay and shot-handed.
+
+`pre_processing.py`: Combines game data and roster data into a single dataframe, and transform variables to useful metrics for the scouting team such as Even Strength Goals For%(EV GF%) and Primary Points per Game.