From 0ad4f70469393037b34c0b2f6e30919bc1e2b28c Mon Sep 17 00:00:00 2001
From: Niilo Ursin <niilo.ursin@gmail.com>
Date: Tue, 5 Sep 2017 09:38:27 +0300
Subject: [PATCH] add instructions to manual build and test commands

---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 41 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 938f15c..e2ff8a9 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,48 @@
 Build status:
-- ![Build Status](https://travis-ci.org/osterzel/clamav-rest.svg)
-- ![Container_status](https://quay.io/repository/osterzel/clamav-rest/status)
+- ![Build Status](https://travis-ci.org/niilo/clamav-rest.svg)
+- ![Container_status](https://quay.io/repository/niilo/clamav-rest/status)
 
 This repository contains a basic rest api for clamav which allows sites to scan files as they are uploaded
 
+!! Project needs cleenup, Makefile and documentation oesn't match current status !!
+
 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
+build golang binary and docker image:
+```bash
+env GOOS=linux GOARCH=amd64 go build
+docker build . -t niilo/clamav-rest
+docker run -p 9000:9000 --rm -it niilo/clamav-rest
+```
 
-make test - this will test against the rest api
+Run clamav-rest docker image:
+```bash
+docker run -p 9000:9000 --rm -it niilo/clamav-rest
+```
+
+Test that service detects common test virus signature:
+```bash
+$ curl -i -F "file=@eicar.com.txt" http://localhost:9000/scan
+HTTP/1.1 100 Continue
+
+HTTP/1.1 406 Not Acceptable
+Content-Type: application/json; charset=utf-8
+Date: Mon, 28 Aug 2017 20:22:34 GMT
+Content-Length: 56
+
+{ Status: "FOUND", Description: "Eicar-Test-Signature" }
+```
+
+Test that service returns 200 for clean file:
+```bash
+$ curl -i -F "file=@clamrest.go" http://localhost:9000/scan
+
+HTTP/1.1 100 Continue
+
+HTTP/1.1 200 OK
+Content-Type: application/json; charset=utf-8
+Date: Mon, 28 Aug 2017 20:23:16 GMT
+Content-Length: 33
+
+{ Status: "OK", Description: "" }
+```
\ No newline at end of file