Skip to content

Commit 13129bc

Browse files
committed
add example_output for README
1 parent 43899cd commit 13129bc

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# JobTracker
22

3-
JobTracker that relies on email to trace application status and next step.
3+
AI powered tool to trace job application status based on emails.
4+
5+
## Feature
6+
7+
- Easy to customize and use, you can adjust the confidence interval threshold yourself
8+
- Up to 96% accuracy with 0 false positives
49

510
## Getting Started
611

12+
### Video Tutorial
13+
14+
[![How to use JobTracker](https://img.youtube.com/vi/RbxmKXYn8sE/0.jpg)](https://www.youtube.com/watch?v=RbxmKXYn8sE "How to use JobTracker")
15+
16+
717
### Prerequisites
818

919
- Python 3.10
@@ -32,6 +42,16 @@ Export your emails in MBOX format and run the script with the following command:
3242

3343
Replace `<path_to_your_email_file.mbox>` with the path to your MBOX file and `<output_filename.csv>` with your desired output file name.
3444

45+
46+
## Example Output
47+
48+
You would get
49+
50+
![example_output](https://github.com/resumejob/JobTracker/blob/43899cd91b943d9842b7e41c6281f2d54c99420a/example_output.png)
51+
52+
53+
* checkout [example_output CSV](https://github.com/resumejob/JobTracker/blob/main/example_output.csv) for more details
54+
3555
## How It Works
3656

3757
1. Access Data
@@ -56,12 +76,10 @@ Execute the following command to run tests:
5676

5777
python3 -m unittest discover -s tests
5878

59-
Roadmap
79+
## Roadmap
6080

6181
- [ ] Support Local LLMs like Llama
6282

63-
64-
6583
## Contributing
6684
We welcome contributions from the community. If you would like to contribute, please fork the repository and submit a pull request.
6785

@@ -77,3 +95,4 @@ This project is licensed under the MIT License - see the LICENSE.md file for det
7795

7896
### Contact
7997
For any queries, you can reach out to Project Maintainer.
98+

0 commit comments

Comments
 (0)