From 9215d636f3956465c6e9ea62a424ec6d90f4ce80 Mon Sep 17 00:00:00 2001 From: PRIYADARSAN S Date: Thu, 15 Aug 2024 02:57:32 +0530 Subject: [PATCH] readme and license added --- LICENSE | 7 +++ README.md | 154 ++++++++++++++++-------------------------------------- 2 files changed, 52 insertions(+), 109 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1e6897f --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2024 PRIYADARSAN S + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 3daba1d..a4e3a1e 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,22 @@
-# [Title] - [short desc] +# Job Crawler - Automated Job Data Extraction -

[This is a placeholder paragraph. Here some introductory text or describe the content that will eventually go in this section. This text is meant to give a sense of how the final content will look in the design.] -

- -### Supported Platforms - -[![Android](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white)]() -[![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)]() -[![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)]() -[![Node JS](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)]() -[![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)]() -[![Java](https://img.shields.io/badge/Java-ED8B00?style=for-the-badge&logo=openjdk&logoColor=white)]() +

The Job Crawler is an integral component of the Job RAID project, designed to automatically scrape and collect data from various job listing websites. This crawler enables Job RAID to aggregate comprehensive job listings, ensuring that users have access to up-to-date and relevant job opportunities.

--- -[uname-holder/reponame-holder] [npm-name-holder] [wf-holder] - for test&build -

- - GitHub last commit + + GitHub last commit - GitHub commit activity - - - -

- -

- - - - GitHub Actions Build Status - - - - - - GitHub Actions Test Status + GitHub commit activity @@ -56,53 +28,29 @@ - GitHub License - - - - - - GitHub Release + GitHub License -

- -

- - - CodeFactor Grade + + GitHub Release

---- -

- - NPM Downloads + + CodeFactor Grade - GitHub Repo stars - - - -

- ---- - -

- - - - GitHub Sponsors + GitHub Repo stars @@ -118,27 +66,28 @@ - [Use Cases](#use-cases-) - [Friendly request to users](#-friendly-request-to-users) -- [Installation - Step-by-Step Guide](#installation---step-by-step-guide-) -- [Usage](#usage) -- [In-Action](#in-action-) - - [License](#license-%EF%B8%8F) - [Contributing to Our Project](#contributing-to-our-project-) -- [Website](#website-) - [Contact Information](#contact-information) - [Credits](#credits-) ## Features and Benefits ✨ -- [f1] -- [f2] -- [fn] +- Automatically scrapes job data from multiple websites +- Ensures up-to-date job listings for accurate search results +- Handles various job listing formats and structures +- Integrates seamlessly with the Job RAID search engine +- Customizable scraping parameters to focus on specific job types +- Efficiently collects large volumes of job data with minimal manual intervention ## Use Cases ✅ -- [usecase 1] -- [use case 2] +- Gathering job data from multiple sources to ensure a comprehensive job search platform +- Automating the process of collecting job listings, reducing manual effort +- Updating job listings regularly to provide users with the latest opportunities +- Customizing scraping tasks to focus on high-demand job sectors or regions +- Supporting the backend infrastructure of the Job RAID search engine by supplying it with fresh data --- @@ -156,32 +105,9 @@ Thank you for being part of this journey. Your support means the world to us. --- -## Installation - Step-by-Step Guide 🪜 - -[Installation instructions here] - -- **Step 1:** -- **Step 2:** -- **Step 3:** -- **Step 4:** -- **Step 5:** - -## Usage - -- [purpose heading] - [Demonstration here] - -```bash -demo -``` - -## In-Action 🤺 - -[video] or [gif] or [image] - ## License ©️ -This project is licensed under the [Apache License 2.0 or GNU General Public License v3.0 or MIT](LICENSE). +This project is licensed under the [MIT](LICENSE). ## Contributing to Our Project 🤝 @@ -195,17 +121,13 @@ We deeply appreciate everyone who contributes or raises issues—your efforts ar Thank you for being part of this journey! -## Website 🌐 - -[https://darsan.in] - ## Contact Information -For any questions, please reach out via hello@darsan.in or [LinkedIn](https://www.linkedin.com/in/darsan-in/). +For any questions, please reach out via hello@darsan.in ## Credits 🙏🏻 -[credits to lib maintainers/creators] +Thanks to [Vicky](https://github.com/itzvixky) for making one of the job crawlers. --- @@ -278,10 +200,24 @@ For any questions, please reach out via hello@darsan.in or [LinkedIn](https://ww #### Topics