Skip to content

Commit

Permalink
tweak contributing.md, update header badges and formatting in README
Browse files Browse the repository at this point in the history
  • Loading branch information
austin-denoble committed Jul 29, 2024
1 parent 87dafb3 commit 21f3398
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## 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
3. The [protobuf-compiler](https://grpc.io/docs/protoc-installation/)

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
Expand All @@ -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
Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 21f3398

Please sign in to comment.