README.md

# Combo

[![CI](https://github.com/combo-lab/combo/actions/workflows/ci.yml/badge.svg)](https://github.com/combo-lab/combo/actions/workflows/ci.yml)
[![Hex.pm](https://img.shields.io/hexpm/v/combo.svg)](https://hex.pm/packages/combo)

A web framework, that combines the good parts of modern web development.

## Getting started

Read the [documentation](https://hexdocs.pm/combo).

## Contributing

We appreciate any contribution to Combo. Check our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) and [CONTRIBUTING.md](CONTRIBUTING.md) guides for more information. We usually keep a list of features and bugs in the [issue tracker](https://github.com/combo-lab/combo/issues).

### Building from source

To build Combo and its related npm-packages and assets:

```bash
$ mix setup
$ mix build
```

To build the documentation:

```console
$ mix setup
$ mix docs
```

## License

[MIT](./LICENSE)