forgejo-sdk/README.md
Martijn van der Kleijn e2b63c6b49 Add release badge to readme
Signed-off-by: Martijn van der Kleijn <martijn.niji@gmail.com>
2024-06-16 01:49:55 +02:00

29 lines
1.3 KiB
Markdown

# Forgejo SDK for Go
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Release](https://raster.shields.io/badge/dynamic/json.svg?label=release&url=https://codeberg.org/api/v1/repos/mvdkleijn/forgejo-sdk/releases&query=$[0].tag_name)](https://codeberg.org/mvdkleijn/forgejo-sdk/releases)
[![Go Report Card](https://goreportcard.com/badge/codeberg.org/mvdkleijn/forgejo-sdk/forgejo)](https://goreportcard.com/report/codeberg.org/mvdkleijn/forgejo-sdk/forgejo)
[![GoDoc](https://godoc.org/codeberg.org/mvdkleijn/forgejo-sdk/forgejo?status.svg)](https://godoc.org/codeberg.org/mvdkleijn/forgejo-sdk/forgejo)
[![status-badge](https://ci.codeberg.org/api/badges/13417/status.svg)](https://ci.codeberg.org/repos/13417)
This project acts as a client SDK implementation written in Go to interact with the Forgejo API implementation. For further informations take a look at the current [documentation](https://pkg.go.dev/codeberg.org/mvdkleijn/forgejo-sdk/forgejo).
Note: function arguments are escaped by the SDK.
## Use it
```go
import "codeberg.org/mvdkleijn/forgejo-sdk/forgejo"
```
## Version Requirements
* go >= 1.22
* forgejo >= 1.11
## Contributing
Fork -> Patch -> Push -> Pull Request
## License
This project is under the MIT License. See the [LICENSE](LICENSE) file for the full license text.