basic intructions for README
This commit is contained in:
21
README.md
21
README.md
@@ -1,3 +1,24 @@
|
|||||||
# jobs
|
# jobs
|
||||||
|
|
||||||
job scraper
|
job scraper
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Scrapes job listings from website (currently craigslist by region)
|
||||||
|
- Saves job listings to a database
|
||||||
|
- Users can search for job listings by keywords and region
|
||||||
|
- Selection of job listings based on user preferences
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- Database (MySQL/MariaDB)
|
||||||
|
- Python 3.x
|
||||||
|
- Required Python packages (see requirements.txt)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Clone the repository
|
||||||
|
2. Create a virtual environment
|
||||||
|
3. Install dependencies
|
||||||
|
4. Set up environment variables
|
||||||
|
5. Run the application
|
||||||
|
|||||||
Reference in New Issue
Block a user