Skip to content

Commit 35e745f

Browse files
committed
update README with new v2.0.2 features, clean up and restructure
1 parent 140b269 commit 35e745f

File tree

1 file changed

+34
-31
lines changed

1 file changed

+34
-31
lines changed

README.md

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,61 @@
1-
# Leetcode Explained
2-
![version](https://img.shields.io/badge/version-2.0.1-blue)
3-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
1+
# Leetcode Explained ![Downloads](https://img.shields.io/badge/Daily_Users-300+-blue) ![version](https://img.shields.io/badge/version-2.0.2-blue) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
42

5-
Leetcode Explained is a Chrome Extension that allows users to watch Leetcode video solutions directly inside the problem page. It also enhances your Leetcode experience by integrating AI-powered code analysis and solution generation functionality.
6-
7-
Available on the [Chrome Web Store](https://chrome.google.com/webstore/detail/leetcode-explained/cofoinjfjcpgcjiinjhcpomcjoalijbe).
3+
Leetcode Explained is a free, open-source extension that enhances your Leetcoding experience. You can install it from the [Chrome Web Store](https://chrome.google.com/webstore/detail/leetcode-explained/cofoinjfjcpgcjiinjhcpomcjoalijbe).
84

95
## Features
10-
1️⃣ Watch solution videos directly inside each Leetcode problem
116

12-
2️⃣ Analyze your code complexity using ChatGPT
7+
1. Watch the top 5 solution videos directly inside each problem's Solutions tab.
8+
2. Adds the top 5 company tags for each question.
9+
3. (Optional) Hide the examples and edge cases to simulate real interview scenarios.
10+
4. (Requires Login) Get your code's time and space complexity.
11+
5. (Requires Login) Fix bugs in your code & generate the optimal solution.
1312

14-
3️⃣ Fix errors in your code using ChatGPT
13+
## Installation
1514

16-
![Add Video](src/assets/images/screenshots/add-video.png)
17-
![Code Complexity](src/assets/images/screenshots/code-complexity.png)
18-
![Fix Code](src/assets/images/screenshots/fix-code.png)
15+
You can install the extension directly from the [Chrome Web Store](https://chrome.google.com/webstore/detail/leetcode-explained/cofoinjfjcpgcjiinjhcpomcjoalijbe).
1916

20-
Additional details:
21-
- Free and open source: [github.com/zubyj/leetcode-explained](https://github.com/zubyj/leetcode-explained)
22-
- No API key required for using ChatGPT. Simply login to ChatGPT in your browser.
23-
- 5 solution videos added per problem
24-
- No data stored. All data is stored locally in your browser
17+
Alternatively, you can manually install the extension:
2518

26-
## Installation
19+
1. Download the latest version of the extension from the [releases](./build) directory as a zip file.
20+
2. Unzip the downloaded file into a directory.
21+
3. Open Google Chrome and navigate to chrome://extensions.
22+
4. Enable "Developer mode" (top right corner).
23+
5. Click on "Load unpacked" and navigate to the unzipped extension directory, then click "Select".
24+
6. Pin the extension. You should now see the extension icon next to the address bar.
2725

28-
1. Install the extension directly from the [Chrome Web Store](https://chrome.google.com/webstore/detail/leetcode-explained/cofoinjfjcpgcjiinjhcpomcjoalijbe).
26+
## Screenshots
27+
28+
![Add Video](src/assets/images/screenshots/add-video.png)
29+
![Code Complexity](src/assets/images/screenshots/code-complexity.png)
30+
![Fix Code](src/assets/images/screenshots/fix-code.png)
2931

30-
OR
32+
## Tutorial
3133

32-
2. Download the latest version of the extension from the [releases](./build) directory as a zip file.
33-
Unzip the downloaded file into a directory.
34-
Open Google Chrome and navigate to chrome://extensions.
35-
Enable "Developer mode" (toggle switch in the top right corner).
36-
Click on "Load unpacked" and navigate to the unzipped extension directory, then click "Select".
37-
Ensure that the extension is enabled. You should now see the extension icon next to the address bar.
34+
After enabling the extension, each question will automatically have the [top 5 solution videos](https://leetcode.com/problems/two-sum/solutions/) and [top 5 companies](https://leetcode.com/problems/two-sum/description/). If you pin the extension in the toolbar & login into ChatGPT in your browser, you can use the following 2 GPT buttons:
3835

39-
## Usage
40-
To view solution videos, open the "Solutions" tab of a Leetcode problem.
41-
For example ➡️ [leetcode.com/problems/two-sum/solutions/](https://leetcode.com/problems/two-sum/solutions/)
36+
- Get your code complexity using ChatGPT
37+
- Fix bugs in your code and return the optimal solution
4238

43-
To fix your code or analyze its complexity, you first need to be logged into ChatGPT in your browser and have this extension pinned. Then, simply open your Leetcode solution and click the extension to use the awesome GPT features!
39+
Please ensure your Leetcode solution is open so the extension can read your code from the page.
4440

4541
## Contributing
46-
Please see the [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on how to contribute to the project.
42+
43+
We welcome contributions! Please see the [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on how to contribute to the project.
4744

4845
## Code of Conduct
46+
4947
We aim to foster an inclusive and respectful environment. Please read the [CODE_OF_CONDUCT.md](docs/CODE_OF_CONDUCT.md) for more information.
5048

5149
## License
50+
5251
Leetcode Explained is [MIT licensed](docs/LICENSE).
5352

5453
## Support
54+
5555
If you encounter any issues or have any questions, please open an issue on this repository.
5656

5757
## Privacy
58+
5859
This extension doesn't collect any personal data. All the code analysis and generation happens on your local machine.
60+
61+
If you like the extension, please leave a review in the Reviews tab. For questions or bugs, feel free to open an issue on Github.

0 commit comments

Comments
 (0)