diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 114f1b0..45a41e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -## Contributing and development +# Contributing -### Prereqs +## Prereqs 1. A [current version of Go](https://go.dev/doc/install) (recommended 1.21+) 2. The [just](https://github.com/casey/just?tab=readme-ov-file#installation) command runner @@ -8,7 +8,7 @@ Then, execute `just bootstrap` to install the necessary Go packages -### .env Setup +## .env Setup An easy way to keep track of necessary environment variables is to create a `.env` file in the root of the project. This project comes with a sample `.env` file (`.env.sample`) that you can copy and modify. At the very least, you @@ -26,9 +26,11 @@ git submodule update --init --recursive For working with submodules, see the [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) documentation. -### Just commands +## Just commands -`just test` : Executes all tests for the pinecone package +`just test` : Executes all tests (unit & integration) for the pinecone package + +`jest test-unit` : Executes unit tests only for the pinecone package `just gen` : Generates Go client code from the API definitions diff --git a/README.md b/README.md index bebe6a8..1b0b21f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -# go-pinecone +# Pinecone Go Client · ![License](https://img.shields.io/github/license/pinecone-io/go-pinecone?color=orange) [![Go Reference](https://pkg.go.dev/badge/github.com/pinecone-io/go-pinecone.svg)](https://pkg.go.dev/github.com/pinecone-io/go-pinecone@main/pinecone) [![Go Report Card](https://goreportcard.com/badge/github.com/pinecone-io/go-pinecone)](https://goreportcard.com/report/github.com/pinecone-io/go-pinecone) -[![Go Reference](https://pkg.go.dev/badge/github.com/pinecone-io/go-pinecone.svg)](https://pkg.go.dev/github.com/pinecone-io/go-pinecone@main/pinecone) - -Official Pinecone Go Client +This is the official Go client for [Pinecone](https://www.pinecone.io). ## Documentation