diff --git a/README.md b/README.md index 256304d..90dea81 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # RADAR -RADAR is a watchdog software to watch file modifications, deletions, movements, creations and scan such files with YARA rules and later analyse them with AI (configurable) and send to your discord webhook (configurable)! Made with <3 in python by inxtagram and _lisa_ns_ \ No newline at end of file +RADAR is a watchdog software to watch file modifications, deletions, movements, creations and scan such files with YARA rules and later analyse them with AI (configurable) and send to your discord webhook (configurable)! + +# Install + +Firstly ensecure you have python3 and pip installed. + +Secondly install packages we are using for RADAR: + +```python +pip install watchdog tomllib yara +``` + +Thirdly run configure config.toml, upload your YARA (.yar and .yara) signatures in /signatures and then finally run RADAR! + +```python +python3 main.py +``` + +Done! You're running RADAR watchdog. + +Made with <3 in python by inxtagram and _lisa_ns_, licensed under [GNU GENERAL PUBLIC LICENSE, Version 3](http://lhhomeserver.ddns.net:3000/Lisa_Stuff/RADAR/src/branch/main/LICENSE) \ No newline at end of file