Skip to content

Commit 0789041

Browse files
committed
README: better look
1 parent 291d748 commit 0789041

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

README.rst

+19-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
.. image:: artwork/logo.gif
2+
:width: 400px
3+
:align: center
4+
15
==========================
2-
Scrapyrt (Scrapy realtime)
6+
ScrapyRT (Scrapy realtime)
37
==========================
48

59
.. image:: https://github.com/scrapinghub/scrapyrt/workflows/CI/badge.svg
@@ -21,29 +25,41 @@ Scrapyrt (Scrapy realtime)
2125
.. image:: https://readthedocs.org/projects/scrapyrt/badge/?version=latest
2226
:target: https://scrapyrt.readthedocs.io/en/latest/api.html
2327

24-
HTTP API for scheduling `Scrapy <https://scrapy.org/>`_ spiders and receiving their items in response.
28+
Schedule your Scrapy spiders and receive data immediately.
29+
30+
ScrapyRT is a HTTP API for scheduling `Scrapy <https://scrapy.org/>`_ spiders and receiving collected items in response.
2531

2632
Quickstart
2733
===============
2834

2935
**1. install**
3036

37+
.. code-block:: shell
38+
3139
> pip install scrapyrt
3240
3341
**2. switch to Scrapy project (e.g. quotesbot project)**
3442

35-
> cd ../quotesbot
43+
.. code-block:: shell
44+
45+
> cd my/project_path/is/quotesbot
3646
3747
**3. launch ScrapyRT**
3848

49+
.. code-block:: shell
50+
3951
> scrapyrt
4052
4153
**4. run your spiders**
4254

55+
.. code-block:: shell
56+
4357
> curl "localhost:9080/crawl.json?spider_name=toscrape-css&url=http://quotes.toscrape.com/"
4458
4559
**5. run more complex query, e.g. specify callback**
4660

61+
.. code-block:: shell
62+
4763
> curl --data '{"request": {"url": "http://quotes.toscrape.com/page/2/"}, "spider_name": "toscrape-css", "crawl_args": {"callback":"other"}}' http://localhost:9080/crawl.json -v
4864
4965
Scrapyrt will look for ``scrapy.cfg`` file to determine your project settings,

artwork/logo.gif

10.5 KB
Loading

artwork/logo.png

22.7 KB
Loading

0 commit comments

Comments
 (0)