Add moar README

This commit is contained in:
Sangeeth Sudheer 2024-06-24 04:34:13 +05:30
parent b66575f8dc
commit dec55fd62b
Signed by: x
GPG Key ID: F6D06ECE734C57D1

View File

@ -10,6 +10,8 @@ LinkedIn job filters are just too limited. There are spammy companies that spray
2. Go to Tampermonkey Dashboard > Settings > Set _Config Mode_ to _Advanced_ (THIS IS MANDATORY!) 2. Go to Tampermonkey Dashboard > Settings > Set _Config Mode_ to _Advanced_ (THIS IS MANDATORY!)
3. Go to LinkedIn Jobs page, verify that extension is loaded and working. It should yell at you. 3. Go to LinkedIn Jobs page, verify that extension is loaded and working. It should yell at you.
NOTE: This script isn't super-resilient and aware of SPA navigations so you might need to refresh if things don't look right after changing config.
## Configuring filters ## Configuring filters
Post following setup instructions, visit Tampermonkey Dashboard > Click on script name > Click _Storage_ tab. Post following setup instructions, visit Tampermonkey Dashboard > Click on script name > Click _Storage_ tab.
@ -33,9 +35,20 @@ Valid values: `"hide-disliked"` (default), `"show-liked"`
As the values suggest, it either hides companies that you set in `disliked` array in storage (default) or it'll only show companies in `liked` array. As the values suggest, it either hides companies that you set in `disliked` array in storage (default) or it'll only show companies in `liked` array.
## Development Notes
This works by basically creating a `MutationObserver` and listening on every change. If there's any change w.r.t one of the job list items, it triggers the logic that runs against ALL the job list items to see if we should show/hide.
Obviously, this isn't very performant and could be optimized but it works.
This also isn't accounting for SPA navigations now, which is another enhancement.
## TODO ## TODO
- [ ] Add icons to job list items to add to liked/disliked to avoid manual edits - [ ] Add icons to job list items to add to liked/disliked to avoid manual edits
- [ ] Show some config UI to toggle between _Show liked_ and _Hide disliked_ modes - [ ] Show some config UI to toggle between _Show liked_ and _Hide disliked_ modes
- [ ] Preconfigured lists of naughty companies (ones who spam the job listings) - [ ] Preconfigured lists of naughty companies (ones who spam the job listings)
- [ ] Perf: Only scope MO to listen on closest parent container
- [ ] Account for SPA navigation (maybe listen on entirety of LinkedIn and detect navigations using History API)
- [ ] Think about other useful filters
- [ ] UI Option to export config quickly