Skip to content

Commit

Permalink
Merge pull request #6 from zytedata/readme
Browse files Browse the repository at this point in the history
Add basic docs.
  • Loading branch information
wRAR authored Oct 27, 2023
2 parents d04289b + d6e0cb4 commit e93fc50
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ zyte-spider-templates

Spider templates for automatic crawlers.

This library contains Scrapy_ spider templates. They can be used out of the box
with the Zyte features such as `Zyte API`_ or modified to be used standalone.
There is a `sample Scrapy project`_ for this library that you can use as a
starting point for your own projects.

.. _Scrapy: https://docs.scrapy.org/
.. _Zyte API: https://docs.zyte.com/zyte-api/get-started.html
.. _sample Scrapy project: https://github.com/zytedata/zyte-spider-templates-project


Requirements
============
Expand All @@ -35,3 +44,10 @@ Installation
.. code-block::
pip install zyte-spider-templates
Spiders
=======

* ``EcommerceSpider``: a spider that can scrape products from any e-commerce
website.

0 comments on commit e93fc50

Please sign in to comment.