Skip to content

Commit 61912c5

Browse files
Add information on the project and some badges at the top of the README (#34)
1 parent d8b07eb commit 61912c5

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,46 @@
1-
# `arizona_example`
1+
# `arizona_example` [![CI][ci-img]][ci] [![Lint][lint-img]][lint]
2+
3+
[ci]: https://github.com/arizona-framework/arizona_example/actions/workflows/ci.yml
4+
[ci-img]: https://github.com/arizona-framework/arizona_example/actions/workflows/ci.yml/badge.svg
5+
[lint]: https://github.com/arizona-framework/arizona_example/actions/workflows/lint.yml
6+
[lint-img]: https://github.com/arizona-framework/arizona_example/actions/workflows/lint.yml/badge.svg
27

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

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

813
If no errors were shown, the application should now be served at `localhost:8080`.
14+
15+
## The project
16+
17+
### Changelog
18+
19+
There is no usable changelog. This example is always using Arizona's latest code.
20+
21+
### Code of Conduct
22+
23+
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).
24+
25+
### Contributing
26+
27+
First of all, thank you for contributing with your time and energy.
28+
29+
If you want to request a new feature make sure to [open an issue](https://github.com/arizona-framework/arizona_example/issues)
30+
so we can discuss it first.
31+
32+
Bug reports and questions are also welcome, but do check you're using the latest version of the
33+
plugin - if you found a bug - and/or search the issue database - if you have a question, since it
34+
might have already been answered before.
35+
36+
Contributions will be subject to the project's license.
37+
38+
For more information check out [CONTRIBUTING.md](https://github.com/arizona-framework/arizona_example/blob/main/CONTRIBUTING.md).
39+
40+
### License
41+
42+
License information can be found inside [LICENSE.md](https://github.com/arizona-framework/arizona_example/blob/main/LICENSE.md).
43+
44+
### Security
45+
46+
This project's security policy is made explicit in [SECURITY.md](https://github.com/arizona-framework/arizona_example/blob/main/SECURITY.md).

0 commit comments

Comments
 (0)