Skip to content

Commit 1250f39

Browse files
authored
prettier readme, more info about features, links
1 parent 7bda259 commit 1250f39

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,16 @@ Scrapyrt (Scrapy realtime)
2525
HTTP server which provides API for scheduling Scrapy spiders and
2626
making requests with spiders.
2727

28-
Allows you to easily add HTTP API to your existing Scrapy project. All Scrapy project
29-
components (e.g. middleware, pipelines, extensions) are supported out of the box. You
30-
simply run Scrapyrt in Scrapy project directory and it starts HTTP server allowing you
31-
to schedule your spiders and get spider output in JSON format.
28+
Features
29+
========
30+
* Allows you to easily add HTTP API to your existing Scrapy project
31+
* All Scrapy project components (e.g. middleware, pipelines, extensions) are supported out of the box.
32+
* You simply run Scrapyrt in Scrapy project directory and it starts HTTP server allowing you to schedule your spiders and get spider output in JSON format.
33+
34+
Note
35+
====
36+
* Project is not a replacement for `Scrapyd <https://scrapyd.readthedocs.io/en/stable/>`_ or `Scrapy Cloud <https://www.zyte.com/scrapy-cloud/>`_ or other infrastructure to run long running crawls
37+
* Not suitable for long running spiders, good for spiders that will fetch one response from some website and return response
3238

3339
Getting started
3440
===============
@@ -66,7 +72,7 @@ with callback ``parse_foo``::
6672
Documentation
6773
=============
6874

69-
Documentation is available here: http://scrapyrt.readthedocs.org/en/latest/index.html
75+
`Documentation is available on readthedocs <http://scrapyrt.readthedocs.org/en/latest/index.html>`_
7076

7177
Support
7278
=======
@@ -81,9 +87,9 @@ Commercial support is also available by `Scrapinghub`_.
8187

8288
License
8389
=======
84-
ScrapyRT is offered under [BSD 3 Clause license](https://en.wikipedia.org/wiki/BSD_licenses).
90+
ScrapyRT is offered under `BSD 3-Clause license <https://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_(%22BSD_License_2.0%22,_%22Revised_BSD_License%22,_%22New_BSD_License%22,_or_%22Modified_BSD_License%22)>`_.
8591

8692

8793
Development
8894
===========
89-
Development taking place on github: https://github.com/scrapinghub/scrapyrt
95+
Development taking place on `Github <https://github.com/scrapinghub/scrapyrt>`_.

0 commit comments

Comments
 (0)