improve documentation

This commit is contained in:
2018-09-16 15:53:47 +01:00
parent a926090bed
commit 524f6a45cd
2 changed files with 13 additions and 5 deletions

View File

@@ -2,7 +2,7 @@
## Requirements
This crawler was written in 3.7.0 to take advantage of the latest `asyncio` features.
This crawler requires at least Python 3.5 in order to utilise the async/await keywords from `asyncio`.
Install required modules:
@@ -13,9 +13,9 @@ pip install -r requirements.txt
Run:
```bash
python crawler.py -u https://urltocrawl.com
python crawler.py -u https://urltocrawl.com [-c 100]
```
## Results
The resulting sitemap will be output in the root of this directory as `sitemap.html`
The resulting sitemap will be output to the root of this directory as `sitemap.html`