Merge pull request #6 from devicecloud-dev/add-device-readme

Add device readme

Author: riglar

README.md

@@ -239,3 +239,33 @@ You can specify which version of Maestro to use (ALPHA feature):
     app-file: app.apk
     maestro-version: 1.39.0
 ```
+
+# Specifying Device Models
+
+You can target specific device models for your tests using the `android-device` or `ios-device` parameters.
+
+See a full list of available device models [here](https://docs.devicecloud.dev/getting-started/devices-configuration).
+
+## Android Device
+
+Specify an Android device model to run your tests on:
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.apk
+    android-device: pixel-6
+```
+
+## iOS Device
+
+Specify an iOS device model to run your tests on:
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.zip
+    ios-device: iphone-14
+```

package.json

@@ -2,7 +2,7 @@
   "name": "dcd-github-action",
   "description": "run maestro tests on devicecloud.dev",
   "author": "devicecloud.dev",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "main": "src/index.ts",
   "license": "MIT",
   "engines": {