Skip to content

Commit

Permalink
Installation instructions improved
Browse files Browse the repository at this point in the history
  • Loading branch information
rhoegg committed Nov 15, 2024
1 parent 53efe21 commit 630e1c6
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# MAC Vectors
![Maven Central](https://img.shields.io/maven-central/v/cloud.anypoint/mule-vectors-connector)


## <img src="icon/icon.svg" width="6%" alt="banner"> [MuleSoft AI Chain Vectors Connector](https://mac-project.ai/docs/mulechain-vectors)
Expand All @@ -14,9 +15,22 @@ MAC Vectors provides access to a broad number of external Vector Stores and Data
- The maximum supported version for Java SDK is JDK 17. You can use JDK 17 only for running your application.
- Compilation with Java SDK must be done with JDK 8.

### Installation

To use this connector, add the following dependency to your application's `pom.xml`:
### Installation (using Cloud.Anypoint Dependency)

```xml
<dependency>
<groupId>cloud.anypoint</groupId>
<artifactId>mule-vectors-connector</artifactId>
<version>0.1.25</version>
<classifier>mule-plugin</classifier>
</dependency>
```

### Installation (building locally)

To use this connector, first [build and install](https://mac-project.ai/docs/mulechain-ai/getting-started) the connector into your local maven repository.
Then add the following dependency to your application's `pom.xml`:

```xml
<dependency>
Expand All @@ -27,6 +41,15 @@ To use this connector, add the following dependency to your application's `pom.x
</dependency>
```

### Installation into private Anypoint Exchange

You can also make this connector available as an asset in your Anyooint Exchange.

This process will require you to build the connector as above, but additionally you will need
to make some changes to the `pom.xml`. For this reason, we recommend you fork the repository.

Then, follow the MuleSoft [documentation](https://docs.mulesoft.com/exchange/to-publish-assets-maven) to modify and publish the asset.

### Documentation
- Check out the complete documentation in [mac-project.ai](https://mac-project.ai/docs/mulechain-vectors)
- Learn from the [Getting Started YouTube Playlist](https://www.youtube.com/playlist?list=PLnuJGpEBF6ZAV1JfID1SRKN6OmGORvgv6)
Expand Down

0 comments on commit 630e1c6

Please sign in to comment.