From fef61cf4ac22850fce7155f3c89a76725d83a159 Mon Sep 17 00:00:00 2001 From: Andrea Angiolillo Date: Fri, 6 Dec 2024 11:41:31 +0000 Subject: [PATCH] doc: Update README.md to use WARNING (#541) --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c9ea9bc2..70bcc0d1 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ # go-client-mongodb-atlas [![PkgGoDev](https://pkg.go.dev/badge/go.mongodb.org/atlas)](https://pkg.go.dev/go.mongodb.org/atlas) ![CI](https://github.com/mongodb/go-client-mongodb-atlas/workflows/CI/badge.svg) +> [!WARNING] +> `go-client-mongodb-atlas` is **deprecated** and doesn't receive feature updates. We recommend migrating to the [Atlas Go SDK](https://github.com/mongodb/atlas-sdk-go) for the latest changes. +> To learn how to migrate from go-client-mongodb-atlas to the Atlas Go SDK, see the [migration guide](https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_3_migration.md). A Go HTTP client for the [MongoDB Atlas API](https://docs.atlas.mongodb.com/api/). Note that `go-client-mongodb-atlas` only supports the two most recent major versions of Go. -## This package is deprecated - -**The `go-client-mongodb-atlas` is deprecated** and doesn't receive feature updates. We recommend migrating to the [Atlas Go SDK](https://github.com/mongodb/atlas-sdk-go) for the latest changes. - -To learn how to migrate from go-client-mongodb-atlas to the Atlas Go SDK, see the [migration guide](https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_3_migration.md). ## Usage