diff --git a/README.md b/README.md index aa3b876..7abf8d3 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ URL Abuse is a versatile free software for URL review, analysis and black-list r - [URL query](https://github.com/CIRCL/urlquery_python_api/) lookup - [CIRCL Passive DNS](http://www.circl.lu/services/passive-dns/) lookup - [CIRCL Passive SSL](http://www.circl.lu/services/passive-ssl/) lookup - - Sphinx search interface to RT/RTIR ticketing systems. The functionality is disabled by default but this can be used to display information about existing report of malicious URLs. + - Sphinx search interface to RT/RTIR ticketing systems. The functionality is disabled by default but can be used to display information about existing report of malicious URLs. Please note that some of the API services will require an API key. The API keys should be located in the root of the URL Abuse directory. @@ -55,6 +55,8 @@ python runapp.py ## Contributing +We welcome pull requests for new extensions, bug fixes. + ### Add a new module Look at the existings functions/modules. The changes will have to be made in the following files: