Skip to content

Commit 8f0d2cc

Browse files
committed
docs: update README to reflect implemented features
- Mark config multi-profile and remote providers as completed - Update milestone to 90% - Remove 'not yet implemented' notice from config section - Update usage section with new --config CLI interface and output format
1 parent 38e0c71 commit 8f0d2cc

1 file changed

Lines changed: 14 additions & 12 deletions

File tree

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Git Reports es una herramienta construida en Rust que analiza repositorios Git y
1717

1818
## 🎯 Estado del Proyecto
1919

20-
**Milestone Actual**: 50% Complete
20+
**Milestone Actual**: 90% Complete
2121

2222
| Característica | Estado |
2323
|---------------|--------|
2424
| Análisis de commits ||
2525
| Métricas de contribuidores ||
26-
| Exportación de reportes | 🚧 WIP |
27-
| Configuración multi-perfil (config.toml) | ⏳ Planificado |
28-
| Soporte providers remotos (GitHub/GitLab/Bitbucket) | ⏳ Planificado |
26+
| Exportación de reportes (JSON) | |
27+
| Configuración multi-perfil (config.toml) | |
28+
| Soporte providers remotos (GitHub/GitLab/Bitbucket) | |
2929
| Visualización web | ⏳ Planificado |
3030

3131
## 🚀 Inicio Rápido
@@ -45,9 +45,7 @@ cargo build --release
4545

4646
## ⚙️ Configuración
4747

48-
> **Estado**: ⏳ Planificado — aún no implementado. El diseño de la configuración está definido en [config.toml.example](config.toml.example) como referencia para la implementación futura.
49-
50-
Git Reports trabajará con perfiles: cada uno agrupa un email, un token y una lista de repositorios remotos. Esto permite manejar varias empresas, providers y cuentas desde un único archivo.
48+
Git Reports trabaja con perfiles: cada uno agrupa un email, un token y una lista de repositorios remotos. Esto permite manejar varias empresas, providers y cuentas desde un único archivo.
5149

5250
### Archivo de configuración
5351

@@ -105,18 +103,22 @@ Ver [config.toml.example](config.toml.example) para un ejemplo completo con todo
105103
106104
## 🖥️ Uso
107105

108-
> **Estado actual**: solo analiza repositorios locales ya clonados.
109-
110106
```bash
111-
cargo run --release -- --repo /path/to/repo --output report.json
107+
# Analizar con config.toml en el directorio actual
108+
cargo run --release -- --period week
109+
110+
# Especificar config y guardar resultado en archivo
111+
cargo run --release -- --config config.toml --period month --output report.json
112112
```
113113

114114
| Argumento | Descripción | Default |
115115
|---|---|---|
116-
| `--repo` | Ruta local al repositorio | `.` |
117-
| `--output` | Archivo JSON de salida ||
116+
| `--config` | Ruta al archivo de configuración | `config.toml` |
117+
| `--output` | Archivo JSON de salida (stdout si no se especifica) ||
118118
| `--period` | Periodo: `week`, `month`, `all` | `week` |
119119

120+
El reporte JSON resultante contiene un array de perfiles, cada uno con sus repos y los commits encontrados para ese email en el periodo indicado.
121+
120122
## 🛠️ Stack Tecnológico
121123

122124
- **Lenguaje**: Rust

0 commit comments

Comments
 (0)