Skip to content

Commit 66e5279

Browse files
authored
Update README and metadata (#50)
## Problem Left placeholders in the README and lacking metadata in Cargo.toml ## Solution This change updates sections of the README and adds metadata to Cargo.toml ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update - [ ] Infrastructure change (CI configs, etc) - [x] Non-code change (docs, etc) - [ ] None of the above: (explain here) ## Test Plan No code was changed. All test cases pass
1 parent e80ce32 commit 66e5279

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

Cargo.toml

+3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ version = "0.1.0"
44
edition = "2021"
55
description = "Pinecone Rust SDK"
66
repository = "https://github.com/pinecone-io/pinecone-rust-client"
7+
homepage = "https://www.pinecone.io/"
78
rust-version = "1.78.0"
89
readme = "./README.md"
910
license = "Apache-2.0"
11+
keywords = ["pinecone", "vector", "database", "cloud", "vectordb"]
12+
categories = ["api-bindings", "database"]
1013

1114
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
1215

README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# Pinecone Rust SDK
22

3+
This SDK is still in an alpha state. While it is mostly built out and functional, it may undergo changes as we continue to improve the UX. Please try it out and give us your feedback, but be aware that updates may introduce breaking changes.
4+
35
## Documentation
46

57
[reference the documentation here]
68

7-
### Example code
8-
9-
[reference the sample app]
10-
119
## Prerequisites
1210

13-
Rust version?
11+
Rust version: tested with Rust version 1.78.0
1412

1513
Before you can use the Pinecone SDK, you must sign up for an account and find your API key in the Pinecone console dashboard at [https://app.pinecone.io](https://app.pinecone.io).
1614

codegen/apis

Submodule apis updated from 4de4456 to 062b114

0 commit comments

Comments
 (0)