Open-source Python library for AI browser agents, plus Browser Use Cloud: stealth browsers and a hosted agent API.
Python ai-agentsai-toolsbrowser-agentbrowser-automationbrowser-usecdpcloud-browsercomputer-useheadless-browserllmmcpplaywrightpythonremote-browserstealth-browserweb-automationweb-scraping
docs: clarify integration example placement
Felix553c211cd51a
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.mdindex 2268db932..67b8c7c5e 100644--- a/.github/CONTRIBUTING.md+++ b/.github/CONTRIBUTING.md@@ -5,3 +5,4 @@ We love contributions! Please read through these links to get started:- 🔢 [Contribution Guidelines](https://docs.browser-use.com/development/contribution-guide)- 👾 [Local Development Setup Guide](https://docs.browser-use.com/development/local-setup)- 🏷️ [Issues Tagged: `#help-wanted`](https://github.com/browser-use/browser-use/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22)+ - 🔌 [Integration Example Guidelines](../examples/integrations/README.md)diff --git a/examples/integrations/README.md b/examples/integrations/README.mdnew file mode 100644index 000000000..68871e483--- /dev/null+++ b/examples/integrations/README.md@@ -0,0 +1,30 @@+# Integration examples++This directory is for examples that show Browser Use working with external products, APIs, and services.++## Where to put integration contributions++- Use `examples/integrations/<provider>/` for small, runnable examples that demonstrate Browser Use with a specific third-party service.+- Use `examples/custom-functions/` for provider-agnostic custom tool patterns.+- Use `browser_use/integrations/<provider>/` only when the integration is shipped as part of the Browser Use package and has tests.+- Keep product-specific workflows, full applications, or large third-party projects in their own repositories.+- Add third-party projects to the community list below instead of vendoring their code into this repository.++## Example checklist++- Use `uv` in setup instructions.+- Keep the example focused on the Browser Use integration point.+- Document required environment variables, OAuth scopes, and local services.+- Do not commit secrets, tokens, generated credentials, or private account data.+- Prefer `ChatBrowserUse()` unless the example is specifically about another model.+- Include the command that runs the example from the repository root.++## Community integrations++External projects listed here are maintained outside this repository. A listing is a pointer for users, not a support guarantee from Browser Use maintainers.++Add entries in this format:++```markdown+- [Project name](https://github.com/org/project) - One sentence about what it integrates with. Maintained by @github-handle.+```