Skip to content

Commit

Permalink
Create how-to-guide.md
Browse files Browse the repository at this point in the history
Created How To Guide
  • Loading branch information
Kudzmat authored Jan 21, 2025
1 parent 3d92bae commit 0c23bf8
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions Docs/how-to-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# How To Be A Shot Geek

If you're reading this, it likely means you consider yourself a "shot sicko." You're not satisfied with just hearing about how great the players
from the 90s were; you want to see the data, analyze the trends, and compare them with what you observe today. Our product, ShotGeek, will help
you do just that and more. This guide will show you how the app operates and how to use its various features. Today, you become a Shot Geek!

---

![Screenshot of ShotGeek landing page](https://github.com/user-attachments/assets/9584108e-5d56-4d7c-b9c6-18e39d65f761)

---

## 1. How to Find a Player Page
To find a specific player’s page:
- Enter the **full name** of the player into the search bar.
- Avoid entering only a first name or making typos, as this may lead to incorrect results or an error page.

**Example**:
To find Charles Barkley's page, enter `"Charles Barkley"` into the search bar.

![Charles Barkley player page](https://github.com/user-attachments/assets/0c2a0d55-a69a-4f15-bad9-219562cfa36f)


Once on the player page:
- You can view the player’s **career stat totals**.
- For deeper analysis, scroll to the bottom of the page:
- Use the dropdown menu to view detailed **tables** for various statistics.
![Table options](https://github.com/user-attachments/assets/aa65f830-ccba-40fd-9cf3-4ea0c53420ff)

- Select a career category (regular season, playoffs etc.) and a stat category from the dropdown menu to view a **graph** visualizing the data.
![Graph options](https://github.com/user-attachments/assets/1e319c92-a2be-494b-9b1a-5ddd426708f4)

---

## 2. How to Change a Player Card
To change Player 1 or Player 2's card:
- Enter the **full name** of the player into the search bar above the respective player card.
- You can only change **one player card at a time**.
- Be sure to use the correct spelling—partial names or typos may result in incorrect results or an error page.
![Changing player card](https://github.com/user-attachments/assets/41fc00ae-d120-4370-ac26-79ccbb61d278)

---

## 3. How to Compare Players
To compare players:
- Click the **Compare Players** button.
- You’ll be redirected to the **comparison page**, where Player 1 and Player 2 will be displayed side by side.
![Player comparion page](https://github.com/user-attachments/assets/f1816c4e-e18d-43f2-a5dc-d65d1447cc50)


On the comparison page:
- View the **career stat totals** for both players.
- For a visual comparison:
- Select a stat option from the dropdown menu to see a **graph comparison** of the players' performance.
![Player comparison graph](https://github.com/user-attachments/assets/1d39628e-97da-41b5-ad4b-d75ff9c37ad1)

---

Now you’re ready to explore ShotGeek and dive into basketball stats like never before!








0 comments on commit 0c23bf8

Please sign in to comment.