Added description in README.md

README.md

@@ -1,5 +1,27 @@
-# Repository Template
+# Lmc API Authentication
 
-This is a repository template for new repositories.
+[![Build](https://github.com/lm-commons/lmc-api-auth/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/lm-commons/lmc-api-auth/actions/workflows/continuous-integration.yml)
+[![Version](https://poser.pugx.org/lm-commons/lmc-api-auth/v)](https://packagist.org/packages/lm-commons/lmc-api-auth)
+[![Total Downloads](https://poser.pugx.org/lm-commons/lmc-api-auth/downloads)](//packagist.org/packages/lm-commons/lmc-api-auth)
+[![License](https://poser.pugx.org/lm-commons/lmc-api-auth/license)](https://packagist.org/packages/lm-commons/lmc-api-auth)
 
-This file should be replaced by your own.
+![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flm-commons%2Flmc-api-auth%2Fproperties%2Fvalues&query=%24%5B%3A1%5D.value&label=Maintenance%20Status)
+
+This component provides middlewares to authenticate API requests.
+
+## Requirements
+
+- PHP 8.3 or higher
+
+## Installation
+
+You can install the LMC API Problem for Mezzio library with composer:
+
+```sh
+$ php composer.phar require lm-commons/lmc-api-auth
+```
+
+## Documentation
+
+Browse the documentation online at
+[LM-Commons](https://lm-commons.github.io/lmc-api-auth/).