[Updated] readme file (#10)

iyashjayesh · Sep 11, 2024 · 5ecec83 · 5ecec83
1 parent 5aca81d
commit 5ecec83
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
-### Status: In Development 🚧 Currently working on fetching function metrics and memory leaks 📊
+### Status: In Development 🚧
+
+### Currently working on fetching function metrics and memory leaks 📊
 
 <p align="center">
   <img src="./static/assets/monigo-icon.png" width="200" title="Monigo Icon" alt="monigo-icon"/>
@@ -162,11 +164,11 @@ Reports need to be generated by the user by clicking on the "Generate Report" bu
 - You can access the MoniGo API by visiting the following URL: http://localhost:8080/monigo/api/v1/<endpoint> (replace `<endpoint>` with the desired endpoint).
 - API endpoints are available for the following:
 
-| Endpoint                           | Description           | Method | Request                                             | Response | Example                                          |
-| ---------------------------------- | --------------------- | ------ | --------------------------------------------------- | -------- | ------------------------------------------------ |
-| `/monigo/api/v1/metrics`           | Get all metrics       | GET    | None                                                | JSON     | [Example](./static/API/Res/metrics.json)           |
-| `/monigo/api/v1/go-routines-stats` | Get go routines stats | GET    | None                                                | JSON     | [Example](./static/API/Res/go-routines-stats.json) |
-| `/monigo/api/v1/service-info`      | Get service info      | GET    | None                                                | JSON     | [Example](./static/API/Res/service-info.json)      |
+| Endpoint                           | Description           | Method | Request                                               | Response | Example                                            |
+| ---------------------------------- | --------------------- | ------ | ----------------------------------------------------- | -------- | -------------------------------------------------- |
+| `/monigo/api/v1/metrics`           | Get all metrics       | GET    | None                                                  | JSON     | [Example](./static/API/Res/metrics.json)           |
+| `/monigo/api/v1/go-routines-stats` | Get go routines stats | GET    | None                                                  | JSON     | [Example](./static/API/Res/go-routines-stats.json) |
+| `/monigo/api/v1/service-info`      | Get service info      | GET    | None                                                  | JSON     | [Example](./static/API/Res/service-info.json)      |
 | `/monigo/api/v1/service-metrics`   | Get service metrics   | POST   | JSON [Example](./static/API/Req/service-metrics.json) | JSON     | [Example](./static/API/Res/service-metrics.json)   |
 | `/monigo/api/v1/reports`           | Get history data      | POST   | JSON [Example](./static/API/Req/reports.json)         | JSON     | [Example](./static/API/Res/reports.json)           |