Skip to content

Commit

Permalink
Update README and metadata (#50)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
emily-emily authored Aug 6, 2024
1 parent e80ce32 commit 66e5279
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ version = "0.1.0"
edition = "2021"
description = "Pinecone Rust SDK"
repository = "https://github.com/pinecone-io/pinecone-rust-client"
homepage = "https://www.pinecone.io/"
rust-version = "1.78.0"
readme = "./README.md"
license = "Apache-2.0"
keywords = ["pinecone", "vector", "database", "cloud", "vectordb"]
categories = ["api-bindings", "database"]

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

Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# Pinecone Rust SDK

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.

## Documentation

[reference the documentation here]

### Example code

[reference the sample app]

## Prerequisites

Rust version?
Rust version: tested with Rust version 1.78.0

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).

Expand Down
2 changes: 1 addition & 1 deletion codegen/apis
Submodule apis updated from 4de445 to 062b11

0 comments on commit 66e5279

Please sign in to comment.