Readme updated

Author: gmkumar2005

README.md

@@ -1,12 +1,11 @@
-Build status [![Scala CI](https://github.com/gmkumar2005/scala-js-env-playwright/actions/workflows/scala.yml/badge.svg)](https://github.com/gmkumar2005/scala-js-env-playwright/actions/workflows/scala.yml)
-
+[![Scala CI](https://github.com/gmkumar2005/scala-js-env-playwright/actions/workflows/scala.yml/badge.svg)](https://github.com/gmkumar2005/scala-js-env-playwright/actions/workflows/scala.yml)
 # scala-js-env-playwright
 A JavaScript environment for Scala.js (a JSEnv) running playwright
 ## Usage
 Add the following line to your `project/plugins.sbt` 
 ```scala
 // For Scala.js 1.x
-libraryDependencies += "io.github.gmkumar2005" %% "scala-js-env-playwright" % "0.1.2-SNAPSHOT"
+libraryDependencies += "io.github.gmkumar2005" %% "scala-js-env-playwright" % "0.1.8"
 ```
 Add the following line to your `build.sbt` 
 ```scala
@@ -17,18 +16,45 @@ Test / jsEnv := new PWEnv(
     )
 ```
 ## Avoid trouble
-* This is a very early version. It is not yet published to maven central. You need to clone this repo and do a `sbt publishLocal` to use it.
+* This is a very early version. It may not work for all projects. It is tested on chrome/chromium and firefox.
+* Few test cases are failing on webkit. Keep a watch on this space for updates.
 * It works only with Scala.js 1.x
 * Make sure the project is set up to use ModuleKind.ESModule in the Scala.js project.
   ```scala
     // For Scala.js 1.x
     scalaJSLinkerConfig ~= { _.withModuleKind(ModuleKind.ESModule) }
     ```
-* Some projects which may need to use both Selenium and Playwright may run into google execption. To resolve this, add the following line to your `plugins.sbt` 
+* Some projects which may need to use both Selenium and Playwright. If it runs into google exception, add the following line to your `plugins.sbt` 
 ```scala
 libraryDependencies += "com.google.guava" % "guava" % "33.0.0-jre"
 ```
 
+## Supported browsers
+* chrome
+* chromium (same as chrome)
+* firefox
+* webkit (experimental)
+
+## Compatibility notes
+### Scala versions
+* This library can be used with any scala version 2.x and 3.x
+* This project is compiled with scala 2.12.18
+### sbt versions
+* This library can be used with any sbt version 1.x 
+### Playwright versions
+* This library can be used with playwright version 1.40.0 `"com.microsoft.playwright" % "playwright" % "1.40.0"`
+### JDK versions
+* This library is tested on JDK11 and JDK21 
+
+## Default configuration
+```scala
+jsEnv := new jsenv.playwright.PWEnv(
+  browserName = "chrome",
+  headless = true,
+  showLogs = false,
+)
+```
+
 ## KeepAlive configuration 
 ```scala
 lazy val pwenvConfig = Def.setting {
@@ -45,14 +71,18 @@ jsEnv := new jsenv.playwright.PWEnv(
 )
 
 ```
+
+## Wiki
+Watch this space for more details on how to use this library.
+
 ## References
 * Sample project using this JSEnv: https://github.com/gmkumar2005/scalajs-sbt-vite-laminar-chartjs-example
 
 ## Todo 
 * Add examples to demonstrate how to use LaunchOptions
 * ~~Add feature to keepAlive the browser~~
 * Optimize to use a single browser instance for all tests by creating multiple tabs
-* Configure github actions to test this project
+* ~~Configure github actions to test this project~~
 * Configure github actions to publish to maven central
 * Verify debug mode works
 * Verify other test frameworks work