shanec/forgejo-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions
forgejo-sdk/README.md

35 lines
1.4 KiB
Markdown
Raw Normal View History

Updated readme with proper badges
2016-11-07 12:42:27 +00:00
# Gitea SDK for Go
Initial commit
2014-11-13 18:05:11 +00:00
docs: update badges in README.md file (#628) - Remove the badge for build status from the README.md file - Add a badge for the MIT license to the README.md file - Add a badge for the release to the README.md file - Add a badge for the chat to the README.md file - Add a badge for microbadger to the README.md file - Add a badge for the Go Report Card to the README.md file - Add a badge for GoDoc to the README.md file Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> Co-authored-by: techknowlogick <techknowlogick@noreply.gitea.com> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/628 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: appleboy <appleboy.tw@gmail.com> Co-committed-by: appleboy <appleboy.tw@gmail.com>
2023-09-06 03:23:01 +01:00
[![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://gitea.com/api/v1/repos/gitea/go-sdk/releases&query=$[0].tag_name)](https://gitea.com/gitea/go-sdk/releases)
[![Join the chat at https://img.shields.io/discord/322538954119184384.svg](https://img.shields.io/discord/322538954119184384.svg)](https://discord.gg/Gitea)
[![Go Report Card](https://goreportcard.com/badge/code.gitea.io/sdk)](https://goreportcard.com/report/code.gitea.io/sdk)
[![GoDoc](https://godoc.org/code.gitea.io/sdk/gitea?status.svg)](https://godoc.org/code.gitea.io/sdk/gitea)
[Frontport] Changelog for v0.11.3 & newline fix (#321) fix newline in readme Changelog v0.11.3 (#320) Changelog v0.11.3 Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/320 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/321 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-by: techknowlogick <techknowlogick@gitea.io>
2020-04-28 04:37:57 +01:00
docs: update badges in README.md file (#628) - Remove the badge for build status from the README.md file - Add a badge for the MIT license to the README.md file - Add a badge for the release to the README.md file - Add a badge for the chat to the README.md file - Add a badge for microbadger to the README.md file - Add a badge for the Go Report Card to the README.md file - Add a badge for GoDoc to the README.md file Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> Co-authored-by: techknowlogick <techknowlogick@noreply.gitea.com> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/628 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: appleboy <appleboy.tw@gmail.com> Co-committed-by: appleboy <appleboy.tw@gmail.com>
2023-09-06 03:23:01 +01:00
This project acts as a client SDK implementation written in Go to interact with the Gitea API implementation. For further informations take a look at the current [documentation](https://pkg.go.dev/code.gitea.io/sdk/gitea).
init commit
2014-11-14 22:07:41 +00:00
UrlEscape Function Arguments used in UrlPath (#273) close #271 * [x] add check if user/repo-name is empty * [x] use net/url for links to encode Co-authored-by: Andrew Thornton <art27@cantab.net> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/273 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: 6543 <6543@obermui.de> Co-committed-by: 6543 <6543@obermui.de>
2021-03-21 20:20:32 +00:00
Note: function arguments are escaped by the SDK.
[README] add import path (#239) add import path add import path to readme Changelog v0.11.0 (#235) Co-authored-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/235 Reviewed-by: lafriks <lafriks@noreply.gitea.io> Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: John Olheiser <john.olheiser@gmail.com> Add TestMyUser (#237) Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/237 Reviewed-by: lafriks <lafriks@noreply.gitea.io> Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/239 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-by: John Olheiser <john.olheiser@gmail.com>
2020-01-29 02:03:08 +00:00
## Use it
```go
import "code.gitea.io/sdk/gitea"
```
Check Gitea Version Requirement (#419) Readme: show Version Requirements SDK: dont support gitea < 1.10 Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/419 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: John Olheiser <john.olheiser@gmail.com>
2020-09-15 17:55:31 +01:00
## Version Requirements
* go >= 1.13
Start v0.14.0 Development (#421) remove unessesary version checks Gitea Version Requirement >= 1.11 set lib version string Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/421 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: John Olheiser <john.olheiser@gmail.com>
2020-09-15 21:46:08 +01:00
* gitea >= 1.11
Check Gitea Version Requirement (#419) Readme: show Version Requirements SDK: dont support gitea < 1.10 Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/419 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: John Olheiser <john.olheiser@gmail.com>
2020-09-15 17:55:31 +01:00
Dropped always outdated contributors file, link to it the graph on readme
2016-11-28 13:34:05 +00:00
## Contributing
Fork -> Patch -> Push -> Pull Request
## Authors
* [Maintainers](https://github.com/orgs/go-gitea/people)
* [Contributors](https://github.com/go-gitea/go-sdk/graphs/contributors)
init commit
2014-11-14 22:07:41 +00:00
## License
[Frontport] Changelog for v0.11.3 & newline fix (#321) fix newline in readme Changelog v0.11.3 (#320) Changelog v0.11.3 Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/320 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/321 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-by: techknowlogick <techknowlogick@gitea.io>
2020-04-28 04:37:57 +01:00
This project is under the MIT License. See the [LICENSE](LICENSE) file for the full license text.
Reference in a new issue Copy permalink