README.md

# phx_custom

> Opinioned code patcher for projects generated by `mix phx.new`.

## Changelog

- Drop Phoenix 1.5 support from `4.0.0`

## Dependencies

- Elixir >= 1.12
- Phoenix >= 1.6.0

## Installation

Install latest version:

```sh
mix archive.install github c4710n/phx_custom
```

Install released version on [Hex.pm](https://hex.pm/):

```
mix archive.install hex phx_custom
```

## Available Tasks

- `mix phx.custom.release`
- `mix phx.custom.docker`

## Docs

- `mix help phx.custom.release`
- `mix help phx.custom.docker`

## Usage

Visit [HexDocs](https://hexdocs.pm/phx_custom) for more details.

For now, have a look at the following quickstart:

```sh
# create an project
$ mix phx.new project
$ cd project

# install dependencies
$ mix deps.get

# patch project for using `mix release`
$ mix phx.custom.release .

$ mix ecto.setup
$ mix phx.server

# patch project for using Docker
$ mix phx.custom.docker .

# build an image for production
$ docker build -t project .
```

## License

MIT