Skip to content

Commit

Permalink
docs: document difference between the exp and exp/kit namespaces (#…
Browse files Browse the repository at this point in the history
…461)

Both namespace have different purposes, this was not documented.
  • Loading branch information
jooola authored Jun 18, 2024
1 parent 92f7c62 commit 4774e3d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion hcloud/exp/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Experimental

The `exp` namespace holds experimental features for the `hcloud-go` library.
The [`exp`](./) namespace holds experimental features for the `hcloud-go` library. The [`exp/kit`](./kit/) namespace is reserved for features not directly related to the `hcloud-go` library, for example the [`sshutils`](./kit/sshutils) package has functions to generate ssh keys.

> [!CAUTION]
> Breaking changes may occur without notice. Do not use in production!
Expand Down

0 comments on commit 4774e3d

Please sign in to comment.