Skip to content

Commit e974f85

Browse files
authored
Update README.md
Add images
1 parent f6b4a36 commit e974f85

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,28 @@ This AWS Lambda function fetches Old School Runescape player progress and posts
55
## Features
66

77
- Fetches player progress from the Wise Old Man API
8-
- Ranks players by either experience, boss, activity, and efficiency metrics
8+
- Wont include inactive players
9+
- Ranks players by either experience, boss, activity, or efficiency metrics
910
- Formats and sends updates to Discord using webhooks
1011
- Designed for automated deployment with GitHub Actions
1112

13+
Ranking Embed
14+
15+
![image](https://github.com/user-attachments/assets/3cac51ec-d546-4b25-82ed-a6e8ed3fb605)
16+
17+
Player Embed
18+
19+
![image](https://github.com/user-attachments/assets/91a5a96f-448b-48c5-add6-a5db4d3d5405)
20+
21+
22+
1223
## Usage
1324

1425
1. Set the following environment variables in Lambda:
1526
- `USERNAMES`: Comma-separated list of OSRS usernames
1627
- `WEBHOOK_URL`: Discord webhook URL
28+
- `SEND_PLAYER_EMBED`: true/false - Defaults to true
29+
- `SEND_RANKING_EMBED`: true/false - Default to true
1730

1831
2. Deploy using your preferred method (e.g., GitHub Actions).
1932

0 commit comments

Comments
 (0)