Skip to content

Commit cb9d9c0

Browse files
committed
separate features in usage section, update structure descriptions, verified extension works on chromium based browsers
1 parent b9a30b3 commit cb9d9c0

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

+17-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Leetcode Explained
22

3-
A Chrome extension that helps you learn and understand Leetcode solutions by providing video explanations and complexity for each solution.
3+
A chrome extension that adds Leetcode video solutions directly into the problem.
44

55
[Available in the Chrome Web Store](https://chrome.google.com/webstore/detail/leetcode-explained/cofoinjfjcpgcjiinjhcpomcjoalijbe)
66

7-
[View the demo on Youtube](https://www.youtube.com/watch?v=E5nvCyVZxuc)
7+
[Watch the demo](https://www.youtube.com/watch?v=E5nvCyVZxuc)
88

9-
### Adds Neetcode video solutions into Leetcode problems
9+
### Adds video solutions into Leetcode problems
1010

1111
![Leetcode Explained Screenshot 2](./assets/images/screenshot-1.jpeg)
1212

@@ -32,28 +32,34 @@ A Chrome extension that helps you learn and understand Leetcode solutions by pro
3232

3333
## Usage
3434

35+
### Access video solutions
36+
1. Navigate to a Leetcode problem page (e.g., `https://leetcode.com/problems/valid-parentheses`).
37+
2. Click the 'Solutions' tab.
38+
3. A video explanation of the solution will be injected into the page if available.
39+
40+
### Get your code's time & space complexity
41+
3542
1. Navigate to a Leetcode problem page (e.g., `https://leetcode.com/problems/valid-parentheses`).
3643
2. Open the extension by clicking on the Leetcode Explained icon in the Chrome toolbar.
3744
3. If not logged in, click the "Please login to ChatGPT" button to authenticate with ChatGPT.
3845
4. Click the "Analyze Complexity" button to get the time and space complexity of the solution.
39-
5. A video explanation of the solution will be injected into the page if available.
4046

4147
## Structure
4248

4349
The extension is organized into the following folders and files:
4450

45-
- `assets/`: Contains images and other static files.
51+
- `assets/`: Contains images and the json data of leetcode problems and their embedded urls
4652
- `src/`: Contains the main source files for the extension.
47-
- `background/`: Contains background script and related files.
48-
- `chatgpt/`: Contains ChatGPT related files.
49-
- `content-script/`: Contains content scripts that interact with the Leetcode website.
50-
- `popup/`: Contains the popup UI for the extension.
51-
- `manifest.json`: The extension manifest file.
53+
- `background/`: Tells content script to add video if tab url matches a leetcode problem name
54+
- `chatgpt/`: Stores auth token when user logs into ChatGPT. ChatGPT is used to get the user's code complexity.
55+
- `content-script/`: Adds video onto the page. Gets user's code to send to ChatGPT.
56+
- `popup/`: Contains the 'Analyze Complexity' button
57+
- `manifest.json`: Metadata such as version, permissions, files, etc.
5258

5359
## Configuration
5460

5561
The extension configuration is contained in the `manifest.json` file. You can update the extension's name, version, description, permissions, and other settings in this file.
5662

5763
## Browser Compatibility
5864

59-
Leetcode Explained has been tested on the Google Chrome browser. It may work on other Chromium-based browsers, but compatibility is not guaranteed.
65+
Leetcode Explained works on most Chromium-based browsers. Other browsers, such as Mozilla Firefox, currently aren't supported.

0 commit comments

Comments
 (0)