Merge pull request #7 from Dharin-shah/main

update Readme

Author: Dharin-shah

README.md

@@ -1,2 +1,38 @@
-# appium-plugins
+# Appium Plugins
+
 Home for Appium Plugins maintained by the BrowserStack Open Source Program Office
+
+To install checkout individual README for each plugins in the repo
+
+
+To activate an installed plugin so that it has an effect for the running server, make sure to include it in the list of activated plugins when starting the server:
+
+```
+appium --plugins=opentelmetry
+```
+
+For information and documentation about each plugin hosted in this repo, head to the individual READMEs:
+
+* [Opentelemetry plugin](packages/opentelemetry) - A plugin designed to automatically generate traces for http events in appium server
+
+# Developer
+
+To run:
+
+```
+npm run clean
+```
+
+or
+
+```
+npm run bootstrap
+npm install
+npm run build
+```
+
+To Test:
+
+```
+npm test:unit
+```

packages/opentelemetry/README.md

@@ -0,0 +1,28 @@
+# Appium Opentelemetry Plugin
+
+With Appium 2.0, we can now use opentelemetry as observability tool without bundling it with appium main server
+
+This plugin will help generate http traces automatically once used and also allow dynamic configurations for different exporters such as prometheus, jaeger, zipkin or just basic console logs.
+
+## Installation - Server
+
+Install the plugin using Appium's plugin CLI, either as a named plugin or via NPM (TODO):
+
+```
+appium plugin install opentelemetry
+appium plugin install --source=npm @browserstack/opentelemetry-plugin
+```
+
+Install the plugin using Appium's plugin CLI, locally:
+
+```
+appium plugin install <path-to-repo>/packages/opentelemetry --source local
+```
+
+## Activation
+
+The plugin will not be active unless turned on when invoking the Appium server:
+
+```
+appium --plugins=opentelemetry
+```