Skip to content

Commit 09e609c

Browse files
committed
Update readme to include information about how to run tests
1 parent 4d08239 commit 09e609c

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@
44
[![Hex Package](https://img.shields.io/hexpm/v/ecto_sqlite3.svg)](https://hex.pm/packages/ecto_sqlite3)
55
[![Hex Docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/ecto_sqlite3)
66

7-
An Ecto SQLite3 Adapter. Uses [Exqlite](https://github.com/elixir-sqlite/exqlite) as the driver to communicate with sqlite3.
7+
An Ecto SQLite3 Adapter. Uses [Exqlite](https://github.com/elixir-sqlite/exqlite)
8+
as the driver to communicate with sqlite3.
89

910
## Caveats and limitations
1011

11-
See [Limitations](https://hexdocs.pm/ecto_sqlite3/Ecto.Adapters.SQLite3.html#module-limitations) in Hexdocs.
12+
See [Limitations](https://hexdocs.pm/ecto_sqlite3/Ecto.Adapters.SQLite3.html#module-limitations)
13+
in Hexdocs.
1214

1315
## Installation
1416

@@ -30,7 +32,8 @@ end
3032

3133
Configure your repository similar to the following. If you want to know more
3234
about the possible options to pass the repository, checkout the documentation
33-
for [`Ecto.Adapters.SQLite`](https://hexdocs.pm/ecto_sqlite3/). It will have more information on what is configurable.
35+
for [`Ecto.Adapters.SQLite`](https://hexdocs.pm/ecto_sqlite3/). It will have
36+
more information on what is configurable.
3437

3538
```elixir
3639
config :my_app,
@@ -45,3 +48,17 @@ config :my_app, MyApp.Repo,
4548
We have some benchmarks comparing it against the `MySQL` and `Postgres` adapters.
4649

4750
You can read more about those at [bench/README.md](bench/README.md).
51+
52+
## Running Tests
53+
54+
Running unit tests
55+
56+
```sh
57+
mix test
58+
```
59+
60+
Runing integration tests
61+
62+
```sh
63+
EXQLITE_INTEGRATION=true mix test
64+
```

0 commit comments

Comments
 (0)