Add explanation to README
This commit is contained in:
parent
a737822076
commit
11a86cead2
1 changed files with 6 additions and 0 deletions
|
@ -37,6 +37,12 @@ pip install -r pip-dependencies.txt
|
||||||
|
|
||||||
\* 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.
|
\* 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.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
The program will visit the website, visit its links and generate a graph from the resulting linkmap. It will write it to `./output.html` and it will try to open this html file with your standard browser.
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
Reference in a new issue