README.md
# Clamxir [![Build Status](https://travis-ci.org/ramortegui/clamxir.svg?branch=master)](https://travis-ci.org/ramortegui/clamxir)
Database wrapper for clamav based on
[clamby](https://github.com/kobaltz/clamby)
This package depends of clamd and freshclam.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `clamxir` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:clamxir, "~> 0.1.3"}
]
end
```
## TODO
- Update README of functions
- Add test for file with malware(just signature)
- Add sample cases. eg. Phoenix
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/clamxir](https://hexdocs.pm/clamxir).