8000 chore: 💅 update README with usage guidance · alfaarghya/alfa-leetcode-api@2d94330 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2d94330

Browse files
ajchiliajchili
committed
chore: đź’… update README with usage guidance
1 parent 04ea2b3 commit 2d94330

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

‎README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,17 @@ During development, it's recommended to utilize the API locally. To do so, follo
7777

7878
### âť“Questions Details
7979

80-
| Details | Endpoint | Description | Demo |
81-
| :-------------------------- | :------------------------------------------- | :------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
82-
| _Daily Problem_ | `/daily` | Get the daily question. | <a href="./public/demo/demo10.png" target="_blank">click here</a> |
83-
| _Selected Problem_ | `/select?titleSlug=selected-question` | Get details about a **_selected-question_**. | <a href="./public/demo/demo11.png" target="_blank">click here</a> |
84-
| _Problems_ | `/problems` | Get a list of 20 problems. | <a href="./public/demo/demo12.png" target="_blank">click here</a> |
85-
| _Limited Problems_ | `/problems?limit=number` | Get a list of a specified **_number_** of problems. | <a href="./public/demo/demo13.png" target="_blank">click here</a> |
86-
| _Filter Problems_ | `/problems?tags=tag1+tag2` | Get a list of problems based on selected **_tags_**. | <a href="./public/demo/demo14.png" target="_blank">click here</a> |
87-
| _Filter & Limited Problems_ | `/problems?tags=tag1+tag2+tag3&limit=number` | Get a list of a specified **_number_** of problems based on selected **_tags_**. | <a href="./public/demo/demo15.png" target="_blank">click here</a> |
80+
| Details | Endpoint | Description | Demo |
81+
| :--------------------------------- | :------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
82+
| _Daily Problem_ | `/daily` | Get the daily question. | <a href="./public/demo/demo10.png" target="_blank">click here</a> |
83+
| _Selected Problem_ | `/select?titleSlug=selected-question` | Get details about a **_selected-question_**. | <a href="./public/demo/demo11.png" target="_blank">click here</a> |
84+
| _Problems_ | `/problems` | Get a list of 20 problems. | <a href="./public/demo/demo12.png" target="_blank">click here</a> |
85+
| _Limited Problems_ | `/problems?limit=number` | Get a list of a specified **_number_** of problems. | <a href="./public/demo/demo13.png" target="_blank">click here</a> |
86+
| _Filter Problems_ | `/problems?tags=tag1+tag2` | Get a list of problems based on selected **_tags_**. | <a href="./public/demo/demo14.png" target="_blank">click here</a> |
87+
| _Skip Problems_ | `/problems?skip=number` | Get a list of 20 problems, skipping a specified **_number_** of problems. | TODO |
88+
| _Filter & Limited Problems_ | `/problems?tags=tag1+tag2+tag3&limit=number` | Get a list of a specified **_number_** of problems based on selected **_tags_**. | <a href="./public/demo/demo15.png" target="_blank">click here</a> |
89+
| _Skip & Limited Problems_ | `/problems?limit=number&skip=number` | Get a list of a specified **_number_** of problems skipping a specified **number** of problems. | TODO |
90+
| _Skip & Filter & Limited Problems_ | `/problems?tags=tag1+tag2+tag3&limit=number&skip=number` | Get a list of a specified **_number_** of problems based on selected **_tags_** skipping a specified **number** of problems. | TODO |
8891

8992
## Author ✒️
9093

0 commit comments

Comments
 (0)
0