# ![Faux](https://github.com/padde/faux/raw/main/guides/images/logo.svg)

[![Build Status](https://github.com/padde/faux/actions/workflows/ci.yml/badge.svg)](https://github.com/padde/faux/actions/workflows/ci.yaml)
[![Version](https://img.shields.io/hexpm/v/faux.svg?logo=elixir&logoColor=A1A8AF)](https://hex.pm/packages/faux)
[![Docs](https://img.shields.io/badge/hex-docs-4B275F.svg?logo=elixir&logoColor=A1A8AF)](https://hexdocs.pm/faux/)
[![Downloads](https://img.shields.io/hexpm/dt/faux.svg?logo=elixir&logoColor=A1A8AF)](https://hex.pm/packages/faux)

*Generate high quality fake data with Elixir.*

## Installation

Install by adding `faux` to your list of dependencies in `mix.exs`:

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

See the [online documentation](https://hexdocs.pm/faux) for more information on
how to get started with Faux.

## Examples

```elixir
iex> Faux.hello()
:world
```