askill
/
Star-Mapper
mirror of https://github.com/Askill/Star-Mapper.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added readme

This commit is contained in:
Askill 2022-01-01 16:56:04 +01:00
parent 715269e726
commit bf0b7b4e89
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,6 +1,17 @@
Flask-URL-Checker # Star-Mapper
For local hosting only. Hosting this application for external users is not recommmended, as it exposes the hoster to potential security risks. Calls every link on a given website and produces an explorable graph visualization.
Please note that the graph layout can take a long time since it is JS based. Loading a graph with 3000 Nodes may take 5 minutes or more.
Map any website. Only map websites you own, as this tool will open any link on a given website, which can potentially incure high costs for the owner and be interpreted as a small scale DOS attack.
optional arguments:
-h, --help show this help message and exit
-url url to map
--plot-cached path to cached file
-limit maximum number of nodes on original site
## Examples:
### Google.de: ### Google.de:
![google.de](./google.png) ![google.de](./google.png)