Skip to content

Commit

Permalink
[#22] docs: user instruction added in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sudiptob2 committed Sep 27, 2022
1 parent 65c12d0 commit a4a9080
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,36 @@
# LeetEasy
![](docs/leeteasy-demo.png)
<br/>
<br/>
Desktop notification for easy daily challenges in [leetcode](https://leetcode.com/).

We all know Leetcode's daily challenges are awesome :sunglasses: However, sometimes these challenges are quite difficult for people who are just starting out problem-solving :smiling_face_with_tear:
This tool will send desktop notification when an **Easy** daily problem is published. This way you won't miss any opportunity to grab some easy **Leetcoins** :coin:
We all know `Leetcode's` daily challenges are awesome :sunglasses: However, sometimes these challenges are quite difficult for people who are just starting out problem-solving :smiling_face_with_tear:
This tool will send desktop notification when an **Easy** daily problem is published. This way you won't miss any opportunity to grab some easy **Leetcoins** :coin: and stay motivated for the day :fire:

# Contribution guideline
## Installation
```shell
pip install leeteasy
```
## run
Schedule leeteasy to send notification for easy leetcode problem at 14:30 (24 hours format time)
```shell
python -m leeteasy start 14:30
```
To add additional difficulty

```shell
python -m leeteasy start 14:30 --difficulty medium
```
This will schedule leeteasy for **Easy and Medium** problem.
To stop leeteasy
```shell
python -m leeteasy stop
```
> **_NOTE:_** By default `leeteasy` checks for scheduled task in every 10 minutes/600 seconds.
> So there might be 10 minutes delay from the actual scheduled time while getting the notification. However,
> this can be controlled using `--sleep_duration` option.
## Contribution guideline

If you like this project and want to improve by adding features, fixing bugs or anything, please follow
the [contributing guidelines](docs/CONTRIBUTING.md).
Binary file added docs/leeteasy-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a4a9080

Please sign in to comment.