Update readme with infomations for running test suite (#8)

skodjob · Nov 10, 2023 · 5b1ae11 · 5b1ae11
1 parent c7f3ee1
commit 5b1ae11
Showing 1 changed file with 14 additions and 1 deletion.
diff --git 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
+```