Skip to content

Commit

Permalink
readme and license added
Browse files Browse the repository at this point in the history
  • Loading branch information
@darsan-in
darsan-in committed Aug 14, 2024
1 parent 07e23a0 commit 9215d63
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 109 deletions.
7 changes: 7 additions & 0 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -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.
154 changes: 45 additions & 109 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,50 +1,22 @@
<div align="center">

# [Title] - [short desc]
# Job Crawler - Automated Job Data Extraction

<p id="intro">[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.]
</p>

### 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)]()
<p id="intro">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.</p>

---

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

<p>

<span>
<a href="https://github.com/uname-holder/reponame-holder/commits/main">
<img src="https://img.shields.io/github/last-commit/uname-holder/reponame-holder?display_timestamp=committer&style=for-the-badge&label=Updated%20On" alt="GitHub last commit"/>
<a href="https://github.com/darsan-in/Job-Crawler/commits/main">
<img src="https://img.shields.io/github/last-commit/darsan-in/Job-Crawler?display_timestamp=committer&style=for-the-badge&label=Updated%20On" alt="GitHub last commit"/>
</a>
</span>

<span>
<a href="">
<img src="https://img.shields.io/github/commit-activity/m/uname-holder/reponame-holder?style=for-the-badge&label=Commit%20Activity" alt="GitHub commit activity"/>
</a>
</span>

</p>

<p>

<span>
<a href="https://github.com/uname-holder/reponame-holder/actions/workflows/wf-holder.yml">
<img src="https://img.shields.io/github/actions/workflow/status/uname-holder/reponame-holder/wf-holder.yml?style=for-the-badge&label=Build%20Status" alt="GitHub Actions Build Status"/>
</a>
</span>

<span>
<a href="https://github.com/uname-holder/reponame-holder/actions/workflows/wf-holder.yml">
<img src="https://img.shields.io/github/actions/workflow/status/uname-holder/reponame-holder/wf-holder.yml?style=for-the-badge&label=Test%20Status" alt="GitHub Actions Test Status"/>
<img src="https://img.shields.io/github/commit-activity/m/darsan-in/Job-Crawler?style=for-the-badge&label=Commit%20Activity" alt="GitHub commit activity"/>
</a>
</span>

Expand All @@ -56,53 +28,29 @@

<span>
<a href="LICENSE">
<img src="https://img.shields.io/github/license/uname-holder/reponame-holder?style=for-the-badge&label=License" alt="GitHub License"/>
</a>
</span>

<span>
<a href="https://github.com/uname-holder/reponame-holder/releases">
<img src="https://img.shields.io/github/v/release/uname-holder/reponame-holder?include_prereleases&sort=date&display_name=tag&style=for-the-badge&label=Latest%20Version" alt="GitHub Release"/>
<img src="https://img.shields.io/github/license/darsan-in/Job-Crawler?style=for-the-badge&label=License" alt="GitHub License"/>
</a>
</span>

</p>

<p>

<span>
<a href="https://www.codefactor.io/repository/github/uname-holder/reponame-holder/issues/main">
<img src="https://img.shields.io/codefactor/grade/github/uname-holder/reponame-holder?style=for-the-badge&label=Code%20Quality%20Grade" alt="CodeFactor Grade"/>
<a href="https://github.com/darsan-in/Job-Crawler/releases">
<img src="https://img.shields.io/github/v/release/darsan-in/Job-Crawler?include_prereleases&sort=date&display_name=tag&style=for-the-badge&label=Latest%20Version" alt="GitHub Release"/>
</a>
</span>

</p>

---

<p>

<span>
<a href="">
<img src="https://img.shields.io/npm/d18m/npm-name-holder?style=for-the-badge&label=Downloads%20On%20NPM" alt="NPM Downloads"/>
<a href="https://www.codefactor.io/repository/github/darsan-in/Job-Crawler/issues/main">
<img src="https://img.shields.io/codefactor/grade/github/darsan-in/Job-Crawler?style=for-the-badge&label=Code%20Quality%20Grade" alt="CodeFactor Grade"/>
</a>
</span>

<span>
<a href="">
<img src="https://img.shields.io/github/stars/uname-holder/reponame-holder?style=for-the-badge&label=Stars" alt="GitHub Repo stars"/>
</a>
</span>

</p>

---

<p>

<span>
<a href="https://github.com/sponsors/darsan-in">
<img src="https://img.shields.io/github/sponsors/darsan-in?style=for-the-badge&label=Generous%20Sponsors" alt="GitHub Sponsors"/>
<img src="https://img.shields.io/github/stars/darsan-in/Job-Crawler?style=for-the-badge&label=Stars" alt="GitHub Repo stars"/>
</a>
</span>

Expand All @@ -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

---

Expand All @@ -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 🤝

Expand All @@ -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 🌐

<a id="url" href="https://darsan.in">[https://darsan.in]</a>

## 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.

---

Expand Down Expand Up @@ -278,10 +200,24 @@ For any questions, please reach out via hello@darsan.in or [LinkedIn](https://ww
#### Topics

<ul id="keywords">

<li>A</li>
<li>B</li>
<li>C</li>
<li>D</li>

<li>job crawler</li>
<li>web scraping</li>
<li>job scraping</li>
<li>data extraction</li>
<li>automated job listings</li>
<li>job data collection</li>
<li>job aggregator</li>
<li>job search automation</li>
<li>web crawler</li>
<li>job search engine</li>
<li>real-time job data</li>
<li>data gathering</li>
<li>scraping jobs</li>
<li>job portal scraping</li>
<li>job listing crawler</li>
<li>job data</li>
<li>crawler integration</li>
<li>job scraping tool</li>
<li>job data miner</li>
<li>multi-site job scraping</li>
</ul>

0 comments on commit 9215d63

Please sign in to comment.