add documentation

andrei1058 · Dec 7, 2023 · 4cde6e2 · 4cde6e2
1 parent f7b644c
commit 4cde6e2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -208,6 +208,9 @@ public class MyPlugin extends JavaPlugin implements Listener {
 }
 ```
 
+## Experimental
+Since 1.20.3 we can replace sidebar score numbers with string placeholders. You can use our experimental feature by implementing **ScoredLine**.
+
 ### Maven repository
 
 ```xml

diff --git a/sidebar-base/src/main/java/com/andrei1058/spigot/sidebar/ScoredLine.java b/sidebar-base/src/main/java/com/andrei1058/spigot/sidebar/ScoredLine.java
@@ -2,6 +2,10 @@
 
 import org.jetbrains.annotations.ApiStatus;
 
+/**
+ * EXPERIMENTAL.
+ * Since 1.20.3 we can replace score numbers on the sidebar with string placeholders.
+ */
 @ApiStatus.Experimental
 public interface ScoredLine {
     @ApiStatus.Experimental