Skip to content

Add information to README about package rename #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhamon merged 3 commits into from
Feb 21, 2025
Merged

Add information to README about package rename #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5bda2e4
Add rename notice to README docs
jhamon Feb 21, 2025
663ec9d
Adjust readme
jhamon Feb 21, 2025
67ef441
Adjust syntax
jhamon Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions docs/upgrading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading