From 10b1f26a914670e0e5947e5fbfd548825c3830af Mon Sep 17 00:00:00 2001 From: Quentin Dufour Date: Sun, 13 Nov 2022 14:52:24 +0100 Subject: [PATCH] Improve README --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f1ead4a..dca4c0e 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,26 @@ Operate your Garage cluster programatically +## ⚠️ DISCLAIMER + +**THESE SDK ARE TECHNICAL PREVIEWS**. The following limitations apply: + - The API is not complete, some actions are possible only through the `garage` binary + - The underlying admin API is not yet stable nor complete, it can breaks at any time + - The generator configuration is currently tweaked, the library might break at any time due to a generator change + - Because the API and the library are not stable, none of them are published in a package manager (npm, pypi, etc.) + - This code has not been extensively tested, some things might not work (please report!) + +To have the best experience possible, please consider: + - Make sure that the version of the library you are using is pinned (`go.sum`, `package-lock.json`, `requirements.txt`). + - Join our Matrix channel at `#garage:deuxfleurs.fr`, say that you are interested by this SDK, and report any friction. + - If stability is critical, mirror this repository on your own infrastructure, + ## For SDK users The following languages are supported: - [Python](#python) - [Javascript](#javascript) - - Golang + - [Golang](#golang) ### Python @@ -116,6 +130,14 @@ See also: - [examples](./example/javascript) - [generated doc](./garage-admin-sdk-js) +### Golang + + + +See also: + - [examples](./example/golang) + - [generated doc](./garage-admin-sdk-golang) + ## For SDK developpers PR are accepted for other languages as soon as meaningful, manually written, covering @@ -136,6 +158,12 @@ gradle validate # (re)build the python client gradle buildPythonClient + +# (re)build the Go client +gradle buildGoClient + +# (re)build the javascrit cient +gradle buildJavascriptClient ``` ## Support a new language