Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme updated #10

Merged
merged 1 commit into from
Jun 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# async-rust-scraper
# Async Rust Web Scraping Project

This project is a Rust-based web scraping application designed to efficiently fetch, parse, and store data from web pages. It utilizes modern Rust async features, robust error handling, and supports multiple database backends.

## Features

- **Asynchronous Web Scraping**: Fast data retrieval and processing using `reqwest` and `tokio`.
- **HTML Parsing**: Extract data seamlessly using the `scraper` library.
- **Flexible Data Storage**: Supports SQLite, PostgreSQL, and Redis.
- **Rate Limiting**: Built-in rate limiting to respect website request policies.
- **Error Handling**: Comprehensive error management to handle network and parsing errors gracefully.
- **Deployment Ready**: Containerized setup for easy deployment.
- **Monitoring**: Integrated logging and monitoring setup.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

What you need to install the software:

- Rust Programming Language
- Cargo (Rust's package manager)
- Docker (optional, for containerization)
- Access to one of the supported databases (SQLite, PostgreSQL, or Redis)

### Installation

1. **Clone the repository**

```bash
git clone https://github.com/yourusername/rust-web-scraper.git
cd rust-web-scraper