From 1a9e50c70a5af3fb036cc8addf24fff884d0f6a1 Mon Sep 17 00:00:00 2001 From: Kerollos Magdy Date: Fri, 31 May 2024 12:31:21 +0300 Subject: [PATCH] Enhance README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index de00aa7..aa0c98f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Railway -Aktive is a simple web-service. It returns a badge (or JSON) that shows your rank among other GitHub users from your country according to your GitHub contributions. +Aktive is a simple web service. It returns a badge (or JSON) that shows your rank among other GitHub users from your country according to your GitHub contributions. > **Note** > @@ -12,6 +12,9 @@ Aktive is a simple web-service. It returns a badge (or JSON) that shows your ran ## Docs +> [!NOTE] +> You can also check the Swagger [API documentation](https://kounter.kerolloz.dev/swagger) for more details. + ### Endpoints > Base URL: @@ -35,8 +38,8 @@ Redirects to this repository. - `style` - Set the style of the badge. Can be one of `flat`, `flat-square`, `for-the-badge`, or `plastic`. Defaults to `flat`. - `label` - Set the left-hand-side text. Defaults to `Most Active GitHub User Rank`. -- `color` - Set background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Defaults to `brightgreen`. -- `labelColor` - Set background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Defaults to `grey`. +- `color` - Set the background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Defaults to `brightgreen`. +- `labelColor` - Set the background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Defaults to `grey`. - `rnkPrefix` - Set prefix to display before the rank value. Defaults to `""` empty string. - `rnkSuffix` - Set suffix to display after the rank value. Defaults to `""` empty string.