Add example to the README

This commit is contained in:
W13R 2021-12-09 11:17:54 +01:00
parent 4fa9d72f7d
commit a737822076
2 changed files with 14 additions and 1 deletions

View file

@ -1,5 +1,7 @@
# linkmapy
Create a graph from the links on a website and the following sites.
## Dependencies
- Python 3.9
@ -29,6 +31,17 @@ pip install -r pip-dependencies.txt
- `-h`, `--help`   show this help message and exit
- `--dump`   Only output the found connections to the console and exit
- `--max-depth N`   The maximum depth at which links will be followed (default: 3)
- `--max-links-per-site N`   The maximum amount of links on a page that will be included (default: 3)
- `--max-links-per-site N`   The maximum amount of links on a page that will be included (default: 3) *
- `--http-download-limit NBYTES`   The maximum length of a requested html file download (in bytes) (default: 10000000)
- `--log`   Log all visited sites and links to stderr
\* when there are more than `max-links-per-site` links on the page, the program will pick `max-links-per-site` random links and ignore the rest.
### Example
```
./linkmapy.py example.org
```
Result:
![](misc/example_graph_screenshot.png)