diff --git a/README.md b/README.md index fa5a049a3..29bb91cd3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,25 @@ -# go-gitlab +# (deprecated) go-gitlab (migrated to https://gitlab.com/gitlab-org/api/client-go) + +🚧 **Project moved to https://gitlab.com/gitlab-org/api/client-go** 🚧 + +This package, `github.com/xanzy/go-gitlab`, has been moved to +[`gitlab.com/gitlab-org/api/client-go`](https://gitlab.com/gitlab-org/api/client-go). + +The project will continue to be a primarily community-maintained project, +more about it [here](https://gitlab.com/gitlab-org/client.go/-/blob/main/README.md#maintenance). + +**References**: + +- [GitLab Project](https://gitlab.com/gitlab-org/api/client-go) +- [Issue Tracker](https://gitlab.com/gitlab-org/api/client-go/-/issues) + +## Migration Steps + +- Replace `github.com/xanzy/go-gitlab` with `gitlab.com/gitlab-org/api/client-go` in your code base. +- Profit 🎉 +- *(the code is fully backwards-compatible, no breaking changes are expected)* + +
Former README contents A GitLab API client enabling Go programs to interact with GitLab in a simple and uniform way @@ -206,3 +227,5 @@ Contributions are always welcome. For more information, check out the [contribut ## License Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + +