Improve README
This commit is contained in:
parent
16ee0d9924
commit
10b1f26a91
1 changed files with 29 additions and 1 deletions
30
README.md
30
README.md
|
@ -2,12 +2,26 @@
|
||||||
|
|
||||||
Operate your Garage cluster programatically
|
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
|
## For SDK users
|
||||||
|
|
||||||
The following languages are supported:
|
The following languages are supported:
|
||||||
- [Python](#python)
|
- [Python](#python)
|
||||||
- [Javascript](#javascript)
|
- [Javascript](#javascript)
|
||||||
- Golang
|
- [Golang](#golang)
|
||||||
|
|
||||||
### Python
|
### Python
|
||||||
|
|
||||||
|
@ -116,6 +130,14 @@ See also:
|
||||||
- [examples](./example/javascript)
|
- [examples](./example/javascript)
|
||||||
- [generated doc](./garage-admin-sdk-js)
|
- [generated doc](./garage-admin-sdk-js)
|
||||||
|
|
||||||
|
### Golang
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
See also:
|
||||||
|
- [examples](./example/golang)
|
||||||
|
- [generated doc](./garage-admin-sdk-golang)
|
||||||
|
|
||||||
## For SDK developpers
|
## For SDK developpers
|
||||||
|
|
||||||
PR are accepted for other languages as soon as meaningful, manually written, covering
|
PR are accepted for other languages as soon as meaningful, manually written, covering
|
||||||
|
@ -136,6 +158,12 @@ gradle validate
|
||||||
|
|
||||||
# (re)build the python client
|
# (re)build the python client
|
||||||
gradle buildPythonClient
|
gradle buildPythonClient
|
||||||
|
|
||||||
|
# (re)build the Go client
|
||||||
|
gradle buildGoClient
|
||||||
|
|
||||||
|
# (re)build the javascrit cient
|
||||||
|
gradle buildJavascriptClient
|
||||||
```
|
```
|
||||||
|
|
||||||
## Support a new language
|
## Support a new language
|
||||||
|
|
Loading…
Reference in a new issue