docs(exp): explain what the experimental namespace is (#439)

This adds an experimental package/namespace `exp` used to experiment features related to the `hcloud-go` library without any promise of stability.
hetznercloud · May 13, 2024 · 0c9ff2f · 0c9ff2f
1 parent 303bd79
commit 0c9ff2f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/hcloud/exp/README.md b/hcloud/exp/README.md
@@ -0,0 +1,8 @@
+# Experimental
+
+The `exp` namespace holds experimental features for the `hcloud-go` library.
+
+> [!CAUTION]
+> Breaking changes may occur without notice. Do not use in production!
+
+When an API reaches a certain level of stability, it may be moved out of the `exp` namespace.
diff --git a/hcloud/exp/doc.go b/hcloud/exp/doc.go
@@ -0,0 +1,4 @@
+// Package exp is a namespace that holds experimental features for the `hcloud-go` library.
+//
+// Breaking changes may occur without notice. Do not use in production!
+package exp