Merge pull request #18 from CyborgTests/new-readme

New readme

Author: soloviovmax

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing to Cyborg Test
+
+🎉 Thanks for your interest in contributing! We welcome issues, suggestions, and pull requests to help improve Cyborg Test.
+
+---
+
+## 🧩 Ways to Contribute
+
+### 🐞 Report Bugs
+If you encounter a bug or unexpected behavior, please open an issue with:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected vs. actual behavior
+- Screenshots or logs if relevant
+- Environment details (OS, Node.js version, Playwright version, etc.)
+
+### 💡 Suggest Features
+Have an idea to improve the project? Let us know! Please explain:
+
+- What the feature does
+- Why it's useful
+- How it might be implemented (if you have ideas)
+
+### 💻 Submit Code
+We welcome pull requests for:
+
+- Bug fixes
+- New features
+- Documentation improvements
+- Refactoring
+
+📌 **Note:** New features should be discussed and confirmed in an issue before development begins. This ensures the feature aligns with the project goals and avoids unnecessary work.

README.md

@@ -1,18 +1,32 @@
+<a href="https://www.cyborgtests.com/" target="_blank">
+  <img src="https://cdn.prod.website-files.com/67f5380f43dbd686532cd541/686bcc6d09e3deeafa38eaed_cyborg-test-banner.png" alt="Banner" style="width: 100%" />
+</a>
+
 # Cyborg Test
+**Capture Manual Steps. Create Automated Tests**
 
-Cyborg Test is a powerfull extension for [Playwright](https://playwright.dev/) that allows you to include manual verification steps in your automated test flow. 
+Cyborg Test is a powerful extension for [Playwright](https://playwright.dev/) that allows you to include manual verification steps in your automated test flow. 
 When a manual step is hit, a separate window appears showing the step description that needs to be executed, so a tester can mark it as passed or failed. 
 This lets you combine automated checks with human input in the same test case.
 
-## Installation
+## 🤖 Demo
+
+See how Cyborg Test turns manual steps into streamlined Playwright tests:
+[YouTube - 🤖 Introducing CyborgTests - Stop Wrestling with Partially Automatable Tests!](https://www.youtube.com/watch?v=jO-N1Fcofog&ab_channel=HOTtesting)
+<div align="center">
+  <img alt="Demo 1" src="https://cdn.prod.website-files.com/67f5380f43dbd686532cd541/686cc5f569c8520273bee57d_ezgif-1db8ce85447022.gif" />
+  <img alt="Demo 2" src="https://cdn.prod.website-files.com/67f5380f43dbd686532cd541/686cc5fc2d926905f881c677_ezgif-1ea65483285706.gif" />
+</div>
+
+## 🚀 Installation
 
 ```bash
 npm install @cyborgtests/test
 ```
 
 This library expects `@playwright/test` to be available in your project as peer dependency.
 
-## Usage
+## 🧪 Usage
 
 ```ts
 import test from '@cyborgtests/test';
@@ -30,7 +44,7 @@ test('example with manual step', async ({ page, manualStep }) => {
 
 When `manualStep` is called the test pauses and the Cyborg Test UI window appears. Use the `✅ Step passed` or `❌ Step failed` buttons to resume the test. Failing a step throws an error so your CI can detect it.
 
-## Soft Fail for Manual Steps
+## ⚠️ Soft Fail for Manual Steps
 
 You can use `manualStep.soft` to mark a manual step as a soft fail. If a soft manual step fails, the test will continue running, and the failure will be annotated as a soft fail (warning) in the report.
 
@@ -44,16 +58,16 @@ await manualStep.soft('This is a soft manual step'); // Test continues if this s
 - Soft fails are shown as warnings in the UI and annotated in the test report.
 - Use soft fails for non-critical manual verifications where you want to highlight issues but not fail the entire test.
 
-## Analytics Configuration
+## 📊 Analytics Configuration
 
-The package includes Google Analytics integration that is enabled by default. The following data is collected:
+Google Analytics is enabled by default to help us understand usage. The following data is collected:
 - Unique user ID (generated on first run)
 - Test execution events (start of the test)
 - Test results (passed/failed)
 - External link clicks
 - Browser, OS information and country
 
-This data helps us understand how the tool is being used and improve it. No personal or sensitive information is collected.
+This data helps us understand how the tool is being used and improve it. We do not collect any personal or sensitive information.
 
 To turn off analytics, use the following configuration:
 
@@ -63,4 +77,13 @@ import { config } from '@cyborgtests/test';
 config.setConfig({
   analyticsEnabled: false
 });
-```
+```
+
+## 🤝 Contributing
+
+We welcome contributions! If you'd like to report a bug, request a feature, or submit a pull request, check out our [contributing guidelines](./CONTRIBUTING.md).
+
+---
+<p align="center">
+  ⭐️ Found this useful? Star the repo to support the project!
+</p>