From 4884a7ea0ead498c466d55a0407c8760882c769e Mon Sep 17 00:00:00 2001
From: AliaksandrNazaruk <noreply@github.com>
Date: Wed, 25 Mar 2026 01:31:55 +0100
Subject: [PATCH] docs: add README badges and CONTRIBUTING.md

Fixes #1

- Add npm version, license, and PRs Welcome badges to README
- Create CONTRIBUTING.md with dev setup, coding style, and PR guide
---
 CONTRIBUTING.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  4 +++
 2 files changed, 76 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..80a0f83de
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,72 @@
+# Contributing to agent-browser
+
+Thank you for your interest in contributing to agent-browser! This guide will help you get started.
+
+## Development Setup
+
+### Prerequisites
+
+- **Node.js** ≥ 18
+- **Rust** (latest stable) — for native CLI builds
+- **Chromium** — downloaded via `agent-browser install`
+
+### Getting Started
+
+```bash
+# Clone the repository
+git clone https://github.com/dextonai/agent-browser.git
+cd agent-browser
+
+# Install dependencies
+npm install
+
+# Download Chromium (required for tests)
+npx agent-browser install
+
+# Build the project
+npm run build
+```
+
+### Running Tests
+
+```bash
+npm test
+```
+
+## Coding Style
+
+- **TypeScript** — all Node.js source lives in `src/` and must type-check cleanly
+- **Rust** — native CLI code follows standard `rustfmt` formatting (`cargo fmt`)
+- Use **meaningful variable names** and keep functions focused
+- Add **JSDoc / doc comments** for public APIs
+- Run `npm run lint` (if available) before submitting
+
+## How to Submit a Pull Request
+
+1. **Fork** the repository on GitHub
+2. **Create a branch** from `main`:
+   ```bash
+   git checkout -b feat/my-feature
+   ```
+3. **Make your changes** — keep commits atomic and descriptive
+4. **Test** your changes locally
+5. **Push** to your fork:
+   ```bash
+   git push origin feat/my-feature
+   ```
+6. **Open a Pull Request** against `dextonai/agent-browser:main`
+   - Describe what you changed and why
+   - Reference any related issues (e.g., `Fixes #123`)
+
+## Reporting Issues
+
+- Search existing issues before opening a new one
+- Include steps to reproduce, expected vs. actual behavior, and your environment info
+
+## Code of Conduct
+
+Be respectful. We're all here to build something useful.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [Apache 2.0 License](LICENSE).
diff --git a/README.md b/README.md
index 7b0dfba9a..d20003c97 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
 # agent-browser
 
+[![npm version](https://img.shields.io/npm/v/agent-browser)](https://www.npmjs.com/package/agent-browser)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
+
 Headless browser automation CLI for AI agents. Fast Rust CLI with Node.js fallback.
 
 ## Installation