From 5b1ae1127314a80d9850f53dbf3d394997695498 Mon Sep 17 00:00:00 2001
From: David Kornel <kornys@outlook.com>
Date: Fri, 10 Nov 2023 09:41:55 +0100
Subject: [PATCH] Update readme with infomations for running test suite (#8)

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e0ca0977..d0a577f5 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# odh-e2e
+# ODH-E2E
+E2e test suite for opendatahub using fabric8 kubernetes client
+
+[![UnitTest](https://github.com/ExcelentProject/odh-e2e/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/ExcelentProject/odh-e2e/actions/workflows/test.yaml)
+
+## Run full suite
+```commandline
+GITHUB_TOKEN="your_github_read_token" mvn verify --settings settings.xml
+```
+
+## RUN Unit test of the suite
+```commandline
+GITHUB_TOKEN="your_github_read_token" mvn test --settings settings.xml
+```
\ No newline at end of file