README.md

# Sambex

Sambex is a library for interacting with SMB (Server Message Block) shares in Elixir.

## Questions

Q: Is it any good?
A:No. It's not. Not yet.

Q: Should you install it?
A: No. It's not ready yet.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `sambex` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:sambex, "~> 0.1.0"}
  ]
end
```

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/sambex>.