Skip to content

Commit

Permalink
Clean up README (#146)
Browse files Browse the repository at this point in the history
## Problem

Clean up README

## Solution

Fix grammar and add some imports for clarity

## Type of Change

- [X] Non-code change (docs, etc)

## Test Plan

NA
  • Loading branch information
rohanshah18 authored Jul 19, 2024
1 parent c50d9a6 commit e5f79bb
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ serverless and regional availability, see [Understanding indexes](https://docs.p
```java
import io.pinecone.clients.Pinecone;
import org.openapitools.client.model.IndexModel;
import org.openapitools.control.client.model.DeletionProtection;

...

Expand All @@ -114,6 +115,8 @@ The following is a minimal example of creating a pod-based index. For all the po
```java
import io.pinecone.clients.Pinecone;
import org.openapitools.client.model.IndexModel;
import org.openapitools.control.client.model.DeletionProtection;

...

Pinecone pinecone = new Pinecone.Builder("PINECONE_API_KEY").build();
Expand All @@ -134,6 +137,7 @@ configuration options, see `main/java/io/pinecone/clients/Pinecone.java`.
```java
import io.pinecone.clients.Pinecone;
import org.openapitools.client.model.IndexModel;
import org.openapitools.control.client.model.DeletionProtection;
...

Pinecone pinecone = new Pinecone.Builder("PINECONE_API_KEY").build();
Expand Down Expand Up @@ -206,7 +210,7 @@ pinecone.configurePodsIndex(indexName, podType, newNumberOfReplicas);

## Enable deletion protection for pod index

The following example enables deletion protection of a pod-based index.
The following example enables deletion protection for a pod-based index.

```java
import io.pinecone.clients.Pinecone;
Expand All @@ -219,7 +223,7 @@ pinecone.configurePodsIndex(indexName, DeletionProtection.ENABLED);

## Enable deletion protection for serverless index

The following example enables deletion protection of a serverless index.
The following example enables deletion protection for a serverless index.

```java
import io.pinecone.clients.Pinecone;
Expand Down

0 comments on commit e5f79bb

Please sign in to comment.