diff --git a/README.md b/README.md new file mode 100644 index 0000000..53621fd --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +This repository contains a basic rest api for clamav which allows sites to scan files as they are uploaded + +Usage: + +make build-container - this will build the docker container and link it up to a clamav container + it exposes a rest api on port 9000 + +make test - this will test against the rest api