diff --git a/README.md b/README.md index 8720cb9..24f8ae9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ # JobTracker -JobTracker that relies on email to trace application status and next step. +AI powered tool to trace job application status based on emails. + +## Feature + +- Easy to customize and use, you can adjust the confidence interval threshold yourself +- Up to 96% accuracy with 0 false positives ## Getting Started +### Video Tutorial + + + + ### Prerequisites - Python 3.10 @@ -32,6 +42,16 @@ Export your emails in MBOX format and run the script with the following command: Replace `` with the path to your MBOX file and `` with your desired output file name. + +## Example Output + +You would get + +![example_output](https://github.com/resumejob/JobTracker/blob/43899cd91b943d9842b7e41c6281f2d54c99420a/example_output.png) + + +* checkout [example_output CSV](https://github.com/resumejob/JobTracker/blob/main/example_output.csv) for more details + ## How It Works 1. Access Data @@ -56,12 +76,10 @@ Execute the following command to run tests: python3 -m unittest discover -s tests -Roadmap +## Roadmap - [ ] Support Local LLMs like Llama - - ## Contributing We welcome contributions from the community. If you would like to contribute, please fork the repository and submit a pull request. @@ -77,3 +95,4 @@ This project is licensed under the MIT License - see the LICENSE.md file for det ### Contact For any queries, you can reach out to Project Maintainer. +