README.md
# ExJsonLogger
A drop-in replacement for `:console`'s formatter. ExJsonLogger takes standard `Logger` calls and JSON encodes them.
Ecto and Plug loggers are also included.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `ex_json_logger` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:ex_json_logger, "~> 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/ex_json_logger](https://hexdocs.pm/ex_json_logger).
* Logger - *For more documentation reference `ExJsonLogger`*
* Plug - *For more documentation reference `ExJsonLogger.Plug.Logger`*
* Ecto - *For more documentation reference `ExJsonLogger.Ecto.Logger`*
## Running the tests
Test include
- Linter via [Credo](https://hex.pm/packages/credo)
- Coverage via [Excoveralls](https://hex.pm/packages/excoveralls)
- run tests: `script/test`
- run tests with coverage: `script/test --coverage`
## Contributing
- Follow the instructions above to install `elixir` and get the repo running.
- If you modify code, add a corresponding test and documentation(if applicable).
- Create a Pull Request (please squash to one concise commit).
- Thanks!
## License
[MIT](https://github.com/rentpath/ex_json_logger/blob/master/LICENSE)