Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jarlah committed Oct 10, 2023
1 parent 80df961 commit 479f2b4
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,8 @@
# TestcontainersElixir
# Testcontainers

Testcontainers is an Elixir library that supports ExUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.
> Testcontainers is an Elixir library that supports ExUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.
## Installation
Current in planning phase. Feedback is appreciated.

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

```elixir
def deps do
[
{:testcontainers_elixir, "~> 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/testcontainers_elixir>.
The plan is to use Gleam for the core. Because the end goal is not to learn Elixir but to provide testcontainer facilities for all kinds Elixir projects my own included.

0 comments on commit 479f2b4

Please sign in to comment.