From 27595c40cceb33219cecd28c14c0e8fbdb566a37 Mon Sep 17 00:00:00 2001
From: Kazuaki Matsuo <fly.49.89.over@gmail.com>
Date: Wed, 23 Oct 2024 18:21:59 -0700
Subject: [PATCH] docs: add options matrix in readme (#1046)

* docs: add options matrix in readme

* chore: revert unnecessary change

* docs: add tweak pathds
---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 2b540d4f..3cb6dfc0 100644
--- a/README.md
+++ b/README.md
@@ -235,6 +235,26 @@ def test_android_click(appium_service, android_driver_factory):
         el.click()
 ```
 
+### Available `options`
+
+Appium Python Client has a common options class named `AppiumOptions` but the available commands are minimal.
+It does not have driver/automationName specific commands unless adding commands with `add_command` method.
+
+Available options for each automation name below will help to check what options are already defined.
+Please use proper options for your automaiton usage.
+
+`automationName` | Package path
+|:---|:-----|
+any | `appium.options.common.base.AppiumOptions`
+`uiautomator2` | `appium.options.android.Uiautomator2Options`
+`espresso` | `appium.options.android.EspressoOptions`
+`xcuitest` | `appium.options.ios.XCUITestOptions`
+`safari` | `appium.options.ios.SafariOptions`
+`mac2` | `appium.options.mac.Mac2Options`
+`windows` | `appium.options.WindowsOptions`
+`gecko` | `appium.options.GeckoOptions`
+`flutterintegration` | `appium.options.flutter_integration.FlutterOptions`
+
 ## Direct Connect URLs
 
 If your Selenium/Appium server decorates the new session capabilities response with the following keys: