Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ramortegui committed Sep 9, 2018
1 parent 2086a6a commit f0765c7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,19 @@
ClamAV wrapper for elixir based on
[clamby](https://github.com/kobaltz/clamby)

This package depends of clamav. For installation instructions please see [https://www.clamav.net/documents/installing-clamav](https://www.clamav.net/documents/installing-clamav)
This package depends of clamav installed on your system. Please refer to: [https://www.clamav.net/documents/installing-clamav](https://www.clamav.net/documents/installing-clamav).

As recomendation, use the daemonize flag on the configs, in order to improve
performance.

## 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`:
The package can be installed by adding `clamxir` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:clamxir, "~> 0.1.4"}
{:clamxir, "~> 0.1.5"}
]
end
```
Expand Down Expand Up @@ -61,7 +63,7 @@ check if the scanner exists, before try to use it.
mix.exs

```elixir
{:clamxir, "~> 0.1.4"}
{:clamxir, "~> 0.1.5"}
```

2. Use in the controller action where the files are uploaded
Expand All @@ -86,10 +88,9 @@ check if the scanner exists, before try to use it.
For a working sample please refer to:
[https://github.com/ramortegui/sample_phoenix_clamxir](https://github.com/ramortegui/sample_phoenix_clamxir)

Docs can be found at [https://hexdocs.pm/clamxir](https://hexdocs.pm/clamxir).


## TODO
- Add Logger features

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).

2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule Clamxir.MixProject do
def project do
[
app: :clamxir,
version: "0.1.4",
version: "0.1.5",
elixir: "~> 1.7.1",
build_embedded: Mix.env() == :prod,
start_permanent: Mix.env() == :prod,
Expand Down

0 comments on commit f0765c7

Please sign in to comment.