From bb138138ad0911bba7eaef71ce7b6d6d4b7617bc Mon Sep 17 00:00:00 2001
From: ylakhdar <ylakhdar@coveo.com>
Date: Tue, 20 Jun 2023 15:07:59 -0400
Subject: [PATCH 1/2] docs: add install instructions

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 42 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 67c9cd4d..89889b18 100644
--- a/README.md
+++ b/README.md
@@ -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

From 95992b7dda061926018c9c267448f519edc4ae69 Mon Sep 17 00:00:00 2001
From: Yassine <ylakhdar@coveo.com>
Date: Wed, 21 Jun 2023 11:39:42 -0400
Subject: [PATCH 2/2] docs: update README.md

Co-authored-by: Mohan Raj Rajamanickam <128537068+mrrajamanickam-coveo@users.noreply.github.com>
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 89889b18..13ebbee0 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ A Coveo Push API Client in Java
 ## Installation
 
 ### 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.
+The Coveo `push-api-client.java` package is stored on Github packages. You will 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)