feat: update readme

vertexcover-io · Dec 26, 2024 · 3cf6adb · 3cf6adb
1 parent 64ff02f
commit 3cf6adb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 Locatr package helps you to find HTML locators on a webpage using prompts and llms. 
 
 ## Overview 
-- LLM based HTML locator finder.
+- LLM based HTML element path finder.
 - Re-rank support for improved accuracy.
 - Supports playwright, selenium, cdp.  
 - Uses cache to reduce calls to llm apis.
@@ -434,4 +434,4 @@ Schema of the json file:
 
 ### Contributing
 
-We welcome contributions! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) guide to get started.
+We welcome contributions! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) guide to get started.
diff --git a/python_client/README.md b/python_client/README.md
@@ -5,7 +5,7 @@
 Locatr package helps you to find HTML locators on a webpage using prompts and llms.
 
 ## Overview 
-- LLM based HTML locator finder.
+- HTML LLM based HTML element path finder.
 - Re-rank support for improved accuracy.
 - Supports playwright, selenium, cdp.  
 - Uses cache to reduce calls to llm apis.
@@ -15,6 +15,7 @@ Example:
 
 ```python
 print(locatr.get_locatr("Search input bar in the page"))
+# output: 'html > div > input'
 ```
 For more examples check the `examples/python` folder.
 
@@ -155,4 +156,4 @@ You can also get locatrs asynchronously. Just call `get_locatr_async`.
 
 ```
     await l.get_locatr_async("red 'yes button' in the form")
-```
+```