diff --git a/README.md b/README.md index 1d5972d..b06e98d 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# Pinecone Scala Client 🗄️ -[![version](https://img.shields.io/badge/version-0.0.1-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/pinecone-scala?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd) +# Pinecone Scala Client 🗂️ +[![version](https://img.shields.io/badge/version-0.1.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/pinecone-scala?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd) This is an intuitive async Scala client for Pinecone API supporting all the available vector and index/collection operations/endpoints, provided in two convenient services called [PineconeVectorService](./pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeVectorService.scala) and [PineconeIndexService](./pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeIndexService.scala). The supported calls are: @@ -21,7 +21,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**. To pull the library you have to add the following dependency to your *build.sbt* ``` -"io.cequence" %% "pinecone-scala-client" % "0.0.1" +"io.cequence" %% "pinecone-scala-client" % "0.1.0" ``` or to *pom.xml* (if you use maven) @@ -30,7 +30,7 @@ or to *pom.xml* (if you use maven) io.cequence pinecone-scala-client_2.12 - 0.0.1 + 0.1.0 ``` @@ -390,7 +390,7 @@ pinecone-scala-client { } ``` -2. _I got an exception like `com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/0.0.1/pinecone-scala-client_2.13-0.0.1.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY}`. What should I do?_ +2. _I got an exception like `com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/0.1.0/pinecone-scala-client_2.13-0.1.0.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY}`. What should I do?_ Set the env. variable `PINECONE_SCALA_CLIENT_API_KEY`. If you don't have one register [here](https://app.pinecone.io/?sessionType=signup). diff --git a/build.sbt b/build.sbt index 12c3735..c4a76e7 100755 --- a/build.sbt +++ b/build.sbt @@ -7,7 +7,7 @@ val scala3 = "3.2.2" ThisBuild / organization := "io.cequence" ThisBuild / scalaVersion := scala212 -ThisBuild / version := "0.0.1" +ThisBuild / version := "0.1.0" ThisBuild / isSnapshot := false lazy val core = (project in file("pinecone-core")) diff --git a/pinecone-client/README.md b/pinecone-client/README.md index 214aa9f..57edff7 100755 --- a/pinecone-client/README.md +++ b/pinecone-client/README.md @@ -1,4 +1,4 @@ -# Pinecone Scala - Client [![version](https://img.shields.io/badge/version-0.0.1-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) +# Pinecone Scala - Client [![version](https://img.shields.io/badge/version-0.1.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) This module provides the actual meat, i.e. WS client implementation ([PineconeVectorService impl and factory](./src/main/scala/io/cequence/pineconescala/service/PineconeVectorServiceImpl.scala) and [PineconeIndexService impl and factory](./src/main/scala/io/cequence/pineconescala/service/PineconeIndexServiceImpl.scala)). Note that the full project documentation can be found [here](../README.md). @@ -10,7 +10,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**. To pull the library you have to add the following dependency to your *build.sbt* ``` -"io.cequence" %% "pinecone-scala-client" % "0.0.1" +"io.cequence" %% "pinecone-scala-client" % "0.1.0" ``` or to *pom.xml* (if you use maven) @@ -19,6 +19,6 @@ or to *pom.xml* (if you use maven) io.cequence pinecone-scala-client_2.12 - 0.0.1 + 0.1.0 ``` \ No newline at end of file diff --git a/pinecone-core/README.md b/pinecone-core/README.md index ec12a4c..22fb480 100755 --- a/pinecone-core/README.md +++ b/pinecone-core/README.md @@ -1,4 +1,4 @@ -# Pinecone Scala - Core [![version](https://img.shields.io/badge/version-0.0.1-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) +# Pinecone Scala - Core [![version](https://img.shields.io/badge/version-0.1.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) This is the core module, which contains mostly domain classes and the definition of services: [PineconeVectorService](./src/main/scala/io/cequence/pineconescala/service/PineconeVectorService.scala) and [PineconeIndexService](./src/main/scala/io/cequence/pineconescala/service/PineconeIndexService.scala). Note that the full project documentation can be found [here](../README.md). @@ -10,7 +10,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**. To pull the library you have to add the following dependency to your *build.sbt* ``` -"io.cequence" %% "pinecone-scala-core" % "0.0.1" +"io.cequence" %% "pinecone-scala-core" % "0.1.0" ``` or to *pom.xml* (if you use maven) @@ -19,6 +19,6 @@ or to *pom.xml* (if you use maven) io.cequence pinecone-scala-core_2.12 - 0.0.1 + 0.1.0 ```