feat: update readme and workflow file

.github/workflows/main.yaml → .github/workflows/test.yaml

@@ -1,4 +1,4 @@
-name: Run-tests
+name: Tests
 on:
   push:
     branches:
@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         go: ['1.23.2']
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, macos-latest]
       fail-fast: true
     runs-on: ${{ matrix.os }}
     steps:

README.md

@@ -1,7 +1,18 @@
 # Locatr 
+[![Go Reference](https://pkg.go.dev/badge/github.com/vertexcover-io/locatr.svg)](https://pkg.go.dev/github.com/vertexcover-io/locatr)
+![Test](https://github.com/vertexcover-io/locatr/actions/workflows/main.yaml/badge.svg)
 
-LLM based html element locator using natural language. 
+Locatr pacakge is an HTML element locator library for playwright-go. It supports natural language inputs to generate JavaScript locators, making it easier to locate HTML elements based on simple descriptions. Future updates may include support for additional plugins like selinium.
 
+Example: 
+
+(input) `Search bar` -> (output) `input#search`
+
+### Install Locatr with
+
+```
+go get github.com/vertexcover-io/locatr
+```
 
 ## Table of Contents
 
@@ -22,7 +33,6 @@ LLM based html element locator using natural language.
     - Default is `false`. Set to `true` to use the cache.
 
 
-
 ### Quick Example
 
 Here's a quick example on how to use the project: