Merge pull request #20 from rachit-lambdatest/main

Updating readme

Author: Shahnawaz-Sk

README.md

@@ -27,6 +27,8 @@ apply plugin: "io.github.lambdatest.gradle"
 
 ```
 ### Add LambdaTest parameters to `build.gradle`:
+#### Configuration for running test and optionally uploading your apps
+
 ```
 runLambdaTest {
     username = 'yourLambdaTestUsername'
@@ -39,12 +41,25 @@ runLambdaTest {
     testSuiteId = "lt//1223444" //provide this only if you have already uploaded the app
 }
 ```
+
+#### Configuration for only uploading your apps
+
+```
+uploadApkToLambdaTest {
+    username = 'yourLambdaTestUsername'
+    accessKey = 'yourLambdaTestAccessKey'
+    appFilePath = 'pathToYourAppFile'
+    testSuiteFilePath = 'pathToYourTestSuite'
+}
+```
+
+
 ### Supported Capabilities:
 
 The following capabilities are supported:
 
-- `app`: Enter the app id generated while uploading the app. Example:lt://APP123456789123456789
-- `testSuite`: Enter the test suite id generated while uploading the test suite. Example: lt://APP123456789123456789
+- `appId`: Enter the app id generated while uploading the app. Example:lt://APP123456789123456789
+- `testSuiteId`: Enter the test suite id generated while uploading the test suite. Example: lt://APP123456789123456789
 - `device`: Enter the name and os version of the device in “DeviceName-OSVersion” format. Example: Pixel 3 XL-9 or Galaxy S21 Ultra 5G-11.
 - `video`: Generate video for all the tests that have run. Example: true.
 - `queueTimeout`: Enter the time in seconds after which you want your build to timeout from queue. Example: 300.
@@ -54,12 +69,23 @@ The following capabilities are supported:
 - `geoLocation`: Set the geolocation country code if you want to enable the same in your test. Example - FR.
 - `tunnel`, `tunnelName`: Set tunnel as true and provide the tunnelName such as NewTunnel as needed if you are running a tunnel.
 
+- `appFilePath` : Path of your app file (this will be uploaded to LambdaTest)
+
+- `testSuiteFilePath` : Path of your test suite apk file (this will be uploaded to LambdaTest)
+
 ## Execution:
-To run the plugin added in the project's `build.gradle`:
+#### To run the test with the plugin added in the project's `build.gradle`:
 ```
 ./gradlew runLambdaTest
 ```
 
+#### If you just want to upload apks and not run actual tests:
+
+```
+./gradlew uploadApkToLambdaTest
+```
+
+
 ## About LambdaTest
 
 [LambdaTest](https://www.lambdatest.com/) is a cloud based selenium grid infrastructure that can