diff --git a/README.md b/README.md index 44ec938..da62cc2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ -Gitea SDK for Go -===================== +# Gitea SDK for Go -This package is still in experiment, see [Wiki](https://github.com/gogits/go-gogs-client/wiki) for documentation. +[![Build Status](https://travis-ci.org/go-gitea/go-sdk.svg?branch=master)](https://travis-ci.org/go-gitea/go-sdk) +[![codecov](https://codecov.io/gh/go-gitea/go-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/go-gitea/go-sdk) +[![Go Report Card](https://goreportcard.com/badge/github.com/go-gitea/go-sdk)](https://goreportcard.com/report/github.com/go-gitea/go-sdk) +[![GoDoc](https://godoc.org/github.com/go-gitea/go-sdk?status.svg)](https://godoc.org/github.com/go-gitea/go-sdk) +[![](https://images.microbadger.com/badges/image/gitea/gitea.svg)](http://microbadger.com/images/gitea/gitea "Get your own image badge on microbadger.com") +[![Join the chat at https://gitter.im/go-gitea/gitea](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/go-gitea/gitea?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +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://godoc.org/github.com/go-gitea/go-sdk). ## License -This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text. \ No newline at end of file +This project is under the MIT License. See the [LICENSE](LICENSE) file for the +full license text.