Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AzeemIdrisi authored Mar 6, 2024
1 parent fa62f82 commit e2af597
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
<img width="400px" src="https://github.com/AzeemIdrisi/LeetCode-Streak-Tracker/assets/112647789/104ced2e-beb1-4d4f-9619-13581377388f"/>
<img width="1000px" src="https://github.com/AzeemIdrisi/LeetCode-Streak-Tracker/assets/112647789/a3db31e0-4adb-4a05-b360-f262b40d218e"/>

## Requirements

Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit e2af597

Please sign in to comment.