<h1 align="center">
    🐴 Roach
</h1>

<p align="center">
<a href="https://packagist.org/packages/roach-php/core">
    <img src="http://poser.pugx.org/roach-php/core/v" alt="Latest Stable Version" />
</a>

<a href="https://packagist.org/packages/roach-php/core">
    <img src="http://poser.pugx.org/roach-php/core/downloads" alt="Total Downloads" />
</a>

<a href="https://github.com/roach-php/core/actions/workflows/run-tests.yml">
    <img src="https://github.com/roach-php/core/actions/workflows/run-tests.yml/badge.svg" alt="">
</a> 
</p>

<p align="center">A complete web scraping toolkit for PHP</p>

## About

Roach is a complete web scraping toolkit for PHP. It is heavily inspired (read: a shameless clone) of the popular [Scrapy](https://docs.scrapy.org)
package for Python.

## Installation

Install the package via composer

```bash
composer require roach-php/core
```

## Documentation

The full documentation can be found [here](https://roach-php.dev).

## Contributing

Please read our [Contribution Guide][contribution-guide] before opening issues 
or pull requests.

## Credits

- [Kai Sassnowski](https://github.com/ksassnowski)
- [All contributors](https://github.com/roach-php/core/contributors)

## License

MIT

[contribution-guide]: https://github.com/roach-php/core/blob/main/CONTRIBUTING.md