From f0765c7bc0e0253ab721943071e4f84f81d4c118 Mon Sep 17 00:00:00 2001 From: Ruben Amortegui Date: Sat, 8 Sep 2018 19:04:41 -0600 Subject: [PATCH] Update documentation. --- README.md | 19 ++++++++++--------- mix.exs | 2 +- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d3777d6..d668f0e 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 @@ -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). - diff --git a/mix.exs b/mix.exs index 0c58b09..1802f8b 100644 --- a/mix.exs +++ b/mix.exs @@ -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,