Update API README.md

api/README.md

@@ -1,6 +1,14 @@
-# YLEM API
-1. OAuth-server. Allows issuing OAuth tokens for customers' applications
-2. API gateway. Checks OAuth authorization token, checks for allowed scopes, proxies the request to backend APIs.
+# YLEM API MICROSERVICE
+
+![Static Badge](https://img.shields.io/badge/Go-1.21-black)
+<a href="https://github.com/ylem-co/ylem?tab=Apache-2.0-1-ov-file">![Static Badge](https://img.shields.io/badge/license-Apache%202.0-black)</a>
+<a href="https://ylem.co" target="_blank">![Static Badge](https://img.shields.io/badge/website-ylem.co-black)</a>
+<a href="https://docs.ylem.co" target="_blank">![Static Badge](https://img.shields.io/badge/documentation-docs.ylem.co-black)</a>
+<a href="https://join.slack.com/t/ylem-co/shared_invite/zt-2nawzl6h0-qqJ0j7Vx_AEHfnB45xJg2Q" target="_blank">![Static Badge](https://img.shields.io/badge/community-join%20Slack-black)</a>
+
+It combines two functionalities
+1. OAuth-server that allows issuing OAuth tokens for customers' applications and provides an API for the UI to be used for it.
+2. API gateway responsible for checking OAuth authorization token validity, checking for allowed scopes, and proxying the request to backend APIs.
 
 ## Run tests
 
@@ -14,7 +22,7 @@ $ go test ./tests/... -v -vet=off
 $ go test ./tests/... -coverpkg=./... 
 ```
 
-Or if you want an advanced coverage report
+## Run tests with an advanced coverage report
 
 ``` bash
 $ go test ./tests/... -coverpkg=./... -coverprofile cover.out