Skip to content

Commit

Permalink
Add information on the project and some badges at the top
Browse files Browse the repository at this point in the history
  • Loading branch information
paulo-ferraz-oliveira committed Jul 21, 2024
1 parent 051bc12 commit c996560
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,46 @@
# `arizona_example`
# `arizona_example` [![CI][ci-img]][ci] [![Lint][lint-img]][lint]

[ci]: https://github.com/arizona-framework/arizona_example/actions/workflows/ci.yml
[ci-img]: https://github.com/arizona-framework/arizona_example/actions/workflows/ci.yml/badge.svg
[lint]: https://github.com/arizona-framework/arizona_example/actions/workflows/lint.yml
[lint-img]: https://github.com/arizona-framework/arizona_example/actions/workflows/lint.yml/badge.svg

This is an example project (`rebar3`-based) for showcasing [Arizona](https://github.com/arizona-framework/arizona)'s
capabilities, always aiming at the tip of its `main` branch (which is why there's no CHANGELOG).

To run it, boot the Erlang/`rebar3` shell: e.g. `rebar3 shell`.

If no errors were shown, the application should now be served at `localhost:8080`.

## The project

### Changelog

There is no usable changelog. This example is always using Arizona's latest code.

### Code of Conduct

This project's code of conduct is made explicit in [CODE_OF_CONDUCT.md](https://github.com/arizona-framework/arizona_example/blob/main/CODE_OF_CONDUCT.md).

### Contributing

First of all, thank you for contributing with your time and energy.

If you want to request a new feature make sure to [open an issue](https://github.com/arizona-framework/arizona_example/issues)
so we can discuss it first.

Bug reports and questions are also welcome, but do check you're using the latest version of the
plugin - if you found a bug - and/or search the issue database - if you have a question, since it
might have already been answered before.

Contributions will be subject to the project's license.

For more information check out [CONTRIBUTING.md](https://github.com/arizona-framework/arizona_example/blob/main/CONTRIBUTING.md).

### License

License information can be found inside [LICENSE.md](https://github.com/arizona-framework/arizona_example/blob/main/LICENSE.md).

### Security

This project's security policy is made explicit in [SECURITY.md](https://github.com/arizona-framework/arizona_example/blob/main/SECURITY.md).

0 comments on commit c996560

Please sign in to comment.