summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJames Every <devstopfix@gmail.com>2020-03-31 10:04:41 +0100
committerJames Every <devstopfix@gmail.com>2020-03-31 10:04:41 +0100
commit7e27fd094cb462d26ba54fde0205a5be313d12da (patch)
tree0e7906d093afb24350f5d516702e97d5e089fc58 /README.md
parentDocs for Phoenix controller [ci skip] (diff)
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index c4a1ebb..35c5f51 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,7 @@ Determine file type. Elixir bindings for [libmagic](http://man7.org/linux/man-pa
## Installation
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `gen_magic` to your list of dependencies in `mix.exs`:
+The package can be installed by adding `gen_magic` to your list of dependencies in `mix.exs`:
```elixir
def deps do
@@ -19,7 +18,7 @@ end
## Usage
-The libmagic library requires a magic file which can be installed in various locations on your file system. A good way of locating it is given in the [config](config/config.exs):
+The libmagic library requires a magic file which can be installed in various locations on your file system. A good way of locating it is given in the [default config](config/config.exs):
```elixir
database = [
@@ -76,4 +75,12 @@ Run an endless cycle to prove that the GenServer is resilient:
```bash
find /usr/share/ -name *png | xargs mix run test/soak.exs
find . -name *ex | xargs mix run test/soak.exs
-``` \ No newline at end of file
+```
+
+## Acknowledgements
+
+Original design, implementation and C code by [Evadne Wu](https://github.com/evadne). Elixir wrapper by [devstopfix](https://github.com/devstopfix/gen_magic).
+
+## License
+
+TBC.