From e2af5974f27937ffdc22432a91ddbc2d5962c278 Mon Sep 17 00:00:00 2001
From: Azeem Idrisi <112647789+AzeemIdrisi@users.noreply.github.com>
Date: Wed, 6 Mar 2024 22:33:23 +0530
Subject: [PATCH] Update README.md
---
README.md | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 3817135..277f468 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,20 @@
-# LeetCode Streak Tracker
+# [LeetCode Streak Tracker](https://azeemidrisi.github.io/LeetCode-Streak-Tracker/)
-LeetCode Streak Tracker is a python script designed to help users track their daily unofficial LeetCode streaks and compete against their friends to maintain the longest streak.
+__LeetCode Streak Tracker__ is a powerful Python script that automates the tracking of daily unofficial LeetCode streaks. It's perfect for those who love a little friendly competition, allowing users to compete against their friends to maintain the longest streak. With automatic updates every day, it's never been easier to stay on top of your game.
+
+**Are you doing 100 days of code challenge?**
+
+Add your LeetCode username to `usernames.txt` and make a pull request to see your streaks on the page.
## Features
- Track daily non-contest LeetCode streaks for multiple users.
- Add friends to the competition and view their streaks using their username only.
- Leaderboard to display the longest streaks among friends.
+- Daily automatic updates.
## Screenshot
-
+
## Requirements
@@ -20,7 +25,7 @@ LeetCode Streak Tracker is a python script designed to help users track their da
- Firefox
## Installation
-
+### Local
1. Clone the repository:
```sh
@@ -53,6 +58,11 @@ k-Sameer_701
python main.py
```
+### GitHub Actions
+1. Fork this repository.
+2. Enable GitHub actions workflow associated with the repository.
+3. Enable GitHub Pages for this repository to see deployed page.
+
## Contributing
Contributions are welcome! Please open an issue or submit a pull request with your suggestions.