Skip to content

docs: add install instructions #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 21, 2023
Merged

docs: add install instructions #92

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb13813
docs: add install instructions
y-lakhdar Jun 20, 2023
95992b7
docs: update README.md
y-lakhdar Jun 21, 2023
cd640ab
Merge branch 'main' into LEN-931
y-lakhdar Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 42 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,50 @@ A Coveo Push API Client in Java

## Installation

Using Maven:
### Step 1: Prerequisites
The Coveo `push-api-client.java` package is stored on Github packages. You will then need a personal access token (classic) with at least `read:packages` scope to install this dependency.

More info, visit [Authenticating to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages)

### Step 2: Update `settings.xml`
You can install this GitHub Package with Apache Maven by editing your `~/.m2/settings.xml`:

#### The repository to the package
Add a definition to the Github Package

```xml
<repository>
<id>github</id>
<url>https://maven.pkg.github.com/coveo/push-api-client.java</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
```

#### Your GitHub personal access token
Your personal access token required to install packages from Github Packages

```xml
<servers>
<server>
<id>github</id>
<username>USERNAME</username>
<password>TOKEN</password>
</server>
</servers>
```
<dependency>
<groupId>com.coveo</groupId>
<artifactId>push-api-client.java</artifactId>
<version>2.2.0</version>
</dependency>

### Step 3: Add Coveo dependency to project
Using Maven:


Add Coveo dependency to your maven project. Instructions on how to do that available in this [URL](https://github.com/coveo/push-api-client.java/packages/1884180).

### Step 4: Install
Run via command line
```bash
mvn install
```

## Usage
Expand Down