[skip ci] docs: improved README layout

Cubxity · Oct 6, 2021 · de5b957 · de5b957
1 parent 5f92a38
commit de5b957
Showing 1 changed file with 41 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -34,8 +34,15 @@ licensed under [GNU LGPLv3](COPYING.LESSER).
 - Prometheus
 - InfluxDB
 
+## Getting started
+
+Read the [wiki](https://github.com/Cubxity/UnifiedMetrics/wiki) for instructions on how to get started.
+
 ## Metrics
 
+<details> 
+  <summary>Table of metrics (click to show)</summary>
+
 | Collector     | Description                                     | Platform            | Default |
 | ------------- | ----------------------------------------------- | ------------------- | ------- |
 | systemGc      | Garbage collection duration and freed bytes     | All                 | true    |
@@ -47,34 +54,51 @@ licensed under [GNU LGPLv3](COPYING.LESSER).
 | tick          | Tick duration histogram                         | Bukkit, Minestom    | true    |
 | world         | World entities, players, and chunks count       | Bukkit, Minestom    | true    |
 
-## Getting started
+</details>
 
-Read the [wiki](https://github.com/Cubxity/UnifiedMetrics/wiki) for instructions.
-
-## Data visualization and analysis
+## Special Thanks
 
-We recommend using [Grafana](https://grafana.com/) as it provides highly customizable diagrams. Grafana provides
-out-of-box support for Prometheus and InfluxDB.
+UnifiedMetrics is a proud partner of DedicatedMC! Get your Raw Power Hosting today with **15% OFF** using
+code `UnifiedMetrics`!
 
-See the [wiki](https://github.com/Cubxity/UnifiedMetrics/wiki/Grafana) for detailed instructions.
+[![DedicatedMC Logo](.github/assets/dmc.png)](https://dedimc.promo/UnifiedMetrics)
 
-> **Note:** InfluxDB Grafana dashboard may be inaccurate due to complications with Flux queries.
+YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET
+applications. YourKit is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/),
+[YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/),
+and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/).
 
-### UnifiedMetrics 0.3.x (stable)
+[![YourKit Logo](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/)
 
-- [InfluxDB (Flux)](https://grafana.com/grafana/dashboards/14755)
-- [Prometheus](https://grafana.com/grafana/dashboards/14756)
+## Servers using UnifiedMetrics
 
-### UnifiedMetrics 0.2.x (legacy)
+<p float="left">
+  <a href="https://craftadia.com">
+    <img
+      src="https://craftadia.com/content/images/2021/01/Webp.net-resizeimage--1-.png"
+      alt="Craftadia"
+      width="200"
+    />
+  </a>
+  <a href="https://octanemc.net">
+    <img
+      src="https://octanemc.net/assets/images/logo-large.png"
+      alt="OctaneMC"
+      width="200"
+    />
+  </a>
+</p>
 
-- [InfluxDB (InfluxQL)](https://grafana.com/grafana/dashboards/13860)
-- [Prometheus](https://grafana.com/grafana/dashboards/14017)
+> **Pssst!** You can add your server here by submitting a *Pull Request*!
 
 ## Building from source
 
+<details> 
+  <summary>Instructions (click to show)</summary>
+
 **Requirements:**
 
-- JDK 11+
+- JDK 8+ (16+ for Fabric)
 - Git (Optional)
 
 To build UnifiedMetrics, you need to obtain the source code first. You can download the source from GitHub or use the
@@ -97,6 +121,7 @@ $ `./gradlew :unifiedmetrics-platform-bukkit:assemble`
 ```
 
 The output artifacts can be found in `subproject/build/libs`.
+</details>
 
 ## API
 
@@ -108,38 +133,4 @@ import dev.cubxity.plugins.metrics.api.UnifiedMetricsProvider
 /* ... */
 
 val api = UnifiedMetricsProvider.get()
-```
-
-## Special Thanks
-
-UnifiedMetrics is a proud partner of DedicatedMC! Get your Raw Power Hosting today with **15% OFF** using code `UnifiedMetrics`!
-
-[![DedicatedMC Logo](.github/assets/dmc.png)](https://dedimc.promo/UnifiedMetrics)
-
-YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET
-applications. YourKit is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/),
-[YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/),
-and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/).
-
-[![YourKit Logo](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/)
-
-## Servers using UnifiedMetrics
-
-<p float="left">
-  <a href="https://craftadia.com">
-    <img
-      src="https://craftadia.com/content/images/2021/01/Webp.net-resizeimage--1-.png"
-      alt="Craftadia"
-      width="200"
-    />
-  </a>
-  <a href="https://octanemc.net">
-    <img
-      src="https://octanemc.net/assets/images/logo-large.png"
-      alt="OctaneMC"
-      width="200"
-    />
-  </a>
-</p>
-
-> **Pssst!** You can add your server here by submitting a *Pull Request*!
+```