Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kuutsav authored Jun 10, 2024
1 parent f55b89b commit c19860f
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ https://kuutsav.github.io/leetcode-compensation/

Analysing compensations mentioned on the Leetcode forums (only supports posts from `India` at the moment).

`Leetcode compensation` works by regularly fetching new posts from the [leetcode compensations page](https://leetcode.com/discuss/compensation).

The `leetcomp` directory contains python scripts to fetch and parse new posts. We use LLMs to parse structured information from the scraped posts.
The `leetcomp` directory contains python scripts to fetch and parse new posts from [https://leetcode.com/discuss/compensation](https://leetcode.com/discuss/compensation).<br>We use LLMs to parse structured information from the scraped posts, which is then satisied and aggregated for reporting.

---

Expand Down Expand Up @@ -66,7 +64,7 @@ uv pip install -r requirements.txt # Install from a requirements.txt file.

## Updating data

> Make sure you have complete the steps above and are in a venv
> Make sure you have completed the steps above and are in a venv
```bash
$ python leetcomp/refresh.py
Expand Down

0 comments on commit c19860f

Please sign in to comment.