README.md

<p align="center">
  <a href="https://hexdocs.pm/neo_faker" target="_blank">
    <img src="./lib/assets/logo/full_logo.svg" width="300" alt="NeoFaker Logo">
  </a>
</p>

# NeoFaker

![Hex.pm Version](https://img.shields.io/hexpm/v/neo_faker) ![Hex.pm Downloads](https://img.shields.io/hexpm/dt/neo_faker) [![Elixir CI](https://github.com/muzhawir/neo_faker/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/muzhawir/neo_faker/actions/workflows/build.yml)

> [!WARNING]
> This project is still in early development. Expect breaking changes.

**NeoFaker** is an Elixir package for generating fake data in tests and development.

## Installation

NeoFaker is available on [Hex](https://hex.pm/packages/neo_faker). Add it to your dependencies in
 `mix.exs`:

```elixir
def deps do
  [
    {:neo_faker, "~> 0.6.0", only: [:dev, :test]}
  ]
end
```

## Documentation

Full documentation is available on [HexDocs](https://hexdocs.pm/neo_faker).

## License

NeoFaker is licensed under the [MIT License](https://github.com/muzhawir/neo_faker/blob/main/LICENSE.md).