docs: initiate a minimal README

README.md

@@ -1,15 +1,24 @@
-# Template project
+# Jackal auth proxy
 
-> Template for [Axone](https://axone.xyz) opensource projects.
+> Jackal proxy ensuring authentication and authorization layer based on Axone.
 
-[![lint](https://img.shields.io/github/actions/workflow/status/axone-protocol/template-oss/lint.yml?branch=main&label=lint&style=for-the-badge&logo=github)](https://github.com/axone-protocol/template-oss/actions/workflows/lint.yml)
+[![version](https://img.shields.io/github/v/release/axone-protocol/jackal-auth-proxy?style=for-the-badge&logo=github)](https://github.com/axone-protocol/jackal-auth-proxy/releases)
+[![lint](https://img.shields.io/github/actions/workflow/status/axone-protocol/jackal-auth-proxy/lint.yml?branch=main&label=lint&style=for-the-badge&logo=github)](https://github.com/axone-protocol/jackal-auth-proxy/actions/workflows/lint.yml)
+[![build](https://img.shields.io/github/actions/workflow/status/axone-protocol/jackal-auth-proxy/build.yml?branch=main&label=build&style=for-the-badge&logo=github)](https://github.com/axone-protocol/jackal-auth-proxy/actions/workflows/build.yml)
+[![test](https://img.shields.io/github/actions/workflow/status/axone-protocol/jackal-auth-proxy/test.yml?branch=main&label=test&style=for-the-badge&logo=github)](https://github.com/axone-protocol/jackal-auth-proxy/actions/workflows/test.yml)
+[![codecov](https://img.shields.io/codecov/c/github/axone-protocol/jackal-auth-proxy?style=for-the-badge&token=6NL9ICGZQS&logo=codecov)](https://codecov.io/gh/axone-protocol/jackal-auth-proxy)
 [![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge&logo=conventionalcommits)](https://conventionalcommits.org)
-[![contributor covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](https://github.com/axone-protocol/.github/blob/main/CODE_OF_CONDUCT.md)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](https://github.com/axone-protocol/.github/blob/main/CODE_OF_CONDUCT.md)
 [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge)](https://opensource.org/licenses/BSD-3-Clause)
 
-## You want to get involved? 😍
+## Prerequisites
 
-Please check out Axone health files :
+- Be sure you have [Golang](https://go.dev/doc/install) installed.
+- [Docker](https://docs.docker.com/engine/install/) as well if you want to use the Makefile.
 
-- [Contributing](https://github.com/axone-protocol/.github/blob/main/CONTRIBUTING.md)
-- [Code of conduct](https://github.com/axone-protocol/.github/blob/main/CODE_OF_CONDUCT.md)
+## Build
+
+```sh
+make build
+```