diff --git a/README.md b/README.md index d45824b9c..627b075e4 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,18 @@ The official Pinecone Python SDK. -For more information, see the docs at https://docs.pinecone.io - - ## Documentation -- [**Reference Documentation**](https://sdk.pinecone.io/python/index.html) +- [**Conceptual docs and guides**](https://docs.pinecone.io) +- [**Python Reference Documentation**](https://sdk.pinecone.io/python/index.html) ### Upgrading the SDK +> [!NOTE] +> The official SDK package was renamed from `pinecone-client` to `pinecone` beginning in version `5.1.0`. +> Please remove `pinecone-client` from your project dependencies and add `pinecone` instead to get +> the latest updates. + For notes on changes between major versions, see [Upgrading](./docs/upgrading.md) ## Prerequisites diff --git a/docs/upgrading.md b/docs/upgrading.md index a6b6d4bec..70e9d5886 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -1,3 +1,8 @@ +> [!NOTE] +> The official SDK package was renamed from `pinecone-client` to `pinecone` beginning in version 5.1.0. +> Please remove `pinecone-client` from your project dependencies and add `pinecone` instead to get +> the latest updates. + # Upgrading from `5.x` to `6.x` ## Breaking changes in 6.x