Skip to content

Commit cf20e5d

Browse files
authored
Add information to README about package rename (#463)
## Problem The rename of the package from `pinecone-client` to `pinecone` is confusing. ## Solution Add information to the README that should hopefully help steer people in the right direction.
2 parents 9363c14 + 67ef441 commit cf20e5d

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@
33

44
The official Pinecone Python SDK.
55

6-
For more information, see the docs at https://docs.pinecone.io
7-
8-
96
## Documentation
107

11-
- [**Reference Documentation**](https://sdk.pinecone.io/python/index.html)
8+
- [**Conceptual docs and guides**](https://docs.pinecone.io)
9+
- [**Python Reference Documentation**](https://sdk.pinecone.io/python/index.html)
1210

1311
### Upgrading the SDK
1412

13+
> [!NOTE]
14+
> The official SDK package was renamed from `pinecone-client` to `pinecone` beginning in version `5.1.0`.
15+
> Please remove `pinecone-client` from your project dependencies and add `pinecone` instead to get
16+
> the latest updates.
17+
1518
For notes on changes between major versions, see [Upgrading](./docs/upgrading.md)
1619

1720
## Prerequisites

docs/upgrading.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
> [!NOTE]
2+
> The official SDK package was renamed from `pinecone-client` to `pinecone` beginning in version 5.1.0.
3+
> Please remove `pinecone-client` from your project dependencies and add `pinecone` instead to get
4+
> the latest updates.
5+
16
# Upgrading from `5.x` to `6.x`
27

38
## Breaking changes in 6.x

0 commit comments

Comments
 (0)