Skip to content

Commit e9e7aa1

Browse files
docs: improve README with project overview, tech stack, and structure
1 parent c70e971 commit e9e7aa1

1 file changed

Lines changed: 61 additions & 12 deletions

File tree

README.md

Lines changed: 61 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,69 @@
1-
# wave-ecosystem-web
1+
# 🌊 Wave Ecosystem
22

3-
Landing page del ecosistema **Wave**: presenta cdpwave, bidiwave, wavexis,
4-
wavexis-mcp y browsix en un solo lugar.
3+
> Landing page del ecosistema **Wave** — automatización de navegador 100% Python, sin Node.js, sin descargas de Chromium.
54
6-
## Objetivo
5+
[![Deploy to GitHub Pages](https://github.com/MathiasPaulenko/wave-ecosystem-web/actions/workflows/deploy.yml/badge.svg)](https://github.com/MathiasPaulenko/wave-ecosystem-web/actions/workflows/deploy.yml)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-22d3ee.svg)](https://opensource.org/licenses/MIT)
77

8-
- Dar visibilidad a las herramientas del ecosistema Wave.
9-
- Reducir la fricción para nuevos usuarios con instalación, docs y comparativas.
10-
- Servir como punto de entrada común para contribuidores.
8+
## Sobre el proyecto
9+
10+
El ecosistema Wave es un conjunto de herramientas Python para automatización de navegador que cubre todo el espectro: desde control a bajo nivel del Chrome DevTools Protocol hasta agentes IA autónomos vía MCP.
11+
12+
| Herramienta | Tipo | Descripción |
13+
|-------------|------|-------------|
14+
| [**cdpwave**](https://github.com/MathiasPaulenko/cdpwave) | Librería async | Chrome DevTools Protocol para Python. 60 dominios, 689 métodos tipados. |
15+
| [**bidiwave**](https://github.com/MathiasPaulenko/bidiwave) | Librería async | WebDriver BiDi (W3C) para Python. Chrome, Firefox y Edge. 27 tipos de eventos. |
16+
| [**wavexis**](https://github.com/MathiasPaulenko/wavexis) | CLI + REPL + HTTP | 130+ comandos CLI, serve mode HTTP, stealth, CI assertions, Core Web Vitals. |
17+
| [**wavexis-mcp**](https://github.com/MathiasPaulenko/wavexis-mcp) | MCP Server | 220 tools en 13 tiers para LLMs. Chrome + Firefox, errores estructurados. |
18+
19+
### Características clave
20+
21+
- **Sin Node.js** — todo es Python puro
22+
- **Sin descargas de Chromium** — usa tu navegador existente
23+
- **W3C WebDriver BiDi** — estándar abierto, no propietario
24+
- **220 MCP tools** — integración nativa con LLMs
25+
- **Stealth mode** — evita detección anti-bot
26+
27+
## Tech stack
28+
29+
- [Astro 5](https://astro.build) — framework web
30+
- [Tailwind CSS v4](https://tailwindcss.com) — estilos
31+
- [GitHub Pages](https://pages.github.com) — hosting
32+
- [GitHub Actions](https://github.com/features/actions) — CI/CD
1133

1234
## Estructura
1335

14-
- `README.md` — este archivo.
15-
- `.gitignore` — ignora la carpeta `ref/` con contexto de desarrollo local.
16-
- `ref/` — contexto y referencias del ecosistema (no se sube al repo, ver `.gitignore`).
36+
```
37+
.
38+
├── .github/workflows/ # Workflow de despliegue a GitHub Pages
39+
├── public/ # Favicon y assets estáticos
40+
├── src/
41+
│ ├── components/ # Componentes Astro (Nav, Hero, ToolGrid, etc.)
42+
│ ├── data/ # Datos centralizados de herramientas (content.ts)
43+
│ ├── layouts/ # Layout base
44+
│ ├── pages/ # Página principal (index.astro)
45+
│ └── styles/ # Estilos globales y design tokens
46+
├── ref/ # Contexto y referencias del proyecto
47+
├── astro.config.mjs # Configuración de Astro
48+
├── package.json
49+
└── tsconfig.json
50+
```
51+
52+
## Desarrollo
53+
54+
```bash
55+
npm install
56+
npm run dev -- --host
57+
```
58+
59+
Abre `http://localhost:4321` en tu navegador.
60+
61+
## Despliegue
62+
63+
El despliegue es automático via GitHub Actions al hacer push a `main`. El sitio se publica en:
64+
65+
**https://mathiaspaulenko.github.io/wave-ecosystem-web/**
1766

18-
## Estado
67+
## Licencia
1968

20-
Idea en fase inicial.
69+
MIT © [Mathias Paulenko](https://github.com/MathiasPaulenko)

0 commit comments

Comments
 (0)