From 11a86cead2da5fc5087ce7aceb908bbb9b7478a8 Mon Sep 17 00:00:00 2001 From: W13R <9070224-W13R@users.noreply.gitlab.com> Date: Thu, 9 Dec 2021 11:22:07 +0100 Subject: [PATCH] Add explanation to README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 13b2fa9..2c87753 100644 --- a/README.md +++ b/README.md @@ -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. +--- + +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 ```