Skip to content

Commit 1575234

Browse files
committed
Add Homebrew installation and to README
1 parent 18b8daf commit 1575234

File tree

3 files changed

+82
-12
lines changed

3 files changed

+82
-12
lines changed

README.es.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,42 @@ GitHub: https://github.com/nbox/API-Key-Health-Checker
1010

1111
Aplicación de escritorio para validar claves API de servicios populares y ejecutar comprobaciones por lotes con límites de tasa y reportes. Compatible con OpenAI (ChatGPT), Google Gemini, YouTube Data API y endpoints personalizados.
1212

13+
![Screenshot](assets/screenshot.png)
14+
15+
## 🍺 Homebrew (macOS)
16+
17+
Instalar:
18+
19+
```bash
20+
brew install --cask nbox/tap/api-key-health-checker
21+
```
22+
23+
Desinstalar:
24+
25+
```bash
26+
brew uninstall --cask api-key-health-checker
27+
```
28+
29+
Eliminar datos de la app:
30+
31+
```bash
32+
brew uninstall --cask --zap api-key-health-checker
33+
```
34+
1335
## Descargar
36+
1437
Lanzamientos: https://github.com/nbox/API-Key-Health-Checker/releases
1538

1639
## macOS Gatekeeper
1740

18-
⚠️ macOS puede bloquear compilaciones sin firma descargadas desde GitHub. Si confías en la app, elimina el atributo de cuarentena:
41+
⚠️ macOS puede bloquear compilaciones sin firma descargadas desde GitHub. Si ves el mensaje "app is damaged and can't be opened. You should move it to the Trash", usa este comando:
1942

2043
```bash
2144
xattr -dr com.apple.quarantine "/Applications/API Key Health Checker.app"
2245
```
2346

2447
## Funciones
48+
2549
- Adaptadores de servicio: OpenAI, Gemini, YouTube, Custom
2650
- Comprobaciones por lotes con concurrencia, retraso aleatorio (jitter), reintentos y limitador global de RPS
2751
- Varias ejecuciones en paralelo con registros en tiempo real, estadísticas y resumen
@@ -30,47 +54,51 @@ xattr -dr com.apple.quarantine "/Applications/API Key Health Checker.app"
3054
- Idiomas de la UI: Inglés (por defecto), Ruso, Español
3155

3256
## Seguridad y privacidad
57+
3358
- Las claves se envían solo al endpoint API seleccionado
3459
- Sin telemetría
3560
- Usa solo claves que te pertenezcan o tengas permiso para probar
3661
- La exportación completa guarda las claves en texto plano (sin cifrado). Úsalo con cuidado.
3762

3863
## Requisitos
64+
3965
- Node.js 20+
4066
- npm
4167

4268
## Inicio rápido
69+
4370
```bash
4471
npm install
4572
npm run dev
4673
```
4774

48-
## Captura de pantalla
49-
50-
![Espacio para la captura](assets/screenshot.png)
51-
5275
## Compilación
76+
5377
```bash
5478
git clone https://github.com/nbox/API-Key-Health-Checker.git
5579
cd API-Key-Health-Checker
5680
npm install
5781
npm run build
5882
npm run dist
5983
```
84+
6085
La salida de compilación se guarda en `dist/`.
6186
DMG: `release/API Key Health Checker-1.0.0-{arch}.dmg`.
6287
macOS: ejecuta `npm run dist` en macOS para generar un `.dmg` en `release/`.
6388
Windows: ejecuta `npm run dist` en Windows para generar un instalador `.exe` en `release/`.
6489

6590
## GitHub Actions release
91+
6692
- En push a `main` o tags `v*`
6793
- Compila para macOS, Windows y Linux
6894
- Crea un GitHub Release con artefactos
6995

7096
## Servicio personalizado
97+
7198
Usa el adaptador Custom para definir base URL, path, tipo de autenticación (bearer/header/query) y códigos de éxito.
7299

73100
## Estructura del proyecto
101+
74102
- `src/main`: proceso principal de Electron y motor de comprobaciones
75103
- `src/renderer`: UI (React + Tailwind)
76104
- `src/shared`: tipos y utilidades compartidas

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,35 @@
88

99
Desktop app to validate API keys for popular services and run batch checks with rate limits and reports. Supports OpenAI (ChatGPT), Google Gemini, YouTube Data API, and custom endpoints.
1010

11-
![Screenshot placeholder](assets/screenshot.png)
11+
![Screenshot](assets/screenshot.png)
12+
13+
## 🍺 Homebrew (macOS)
14+
15+
Install:
16+
17+
```bash
18+
brew install --cask nbox/tap/api-key-health-checker
19+
```
20+
21+
Uninstall:
22+
23+
```bash
24+
brew uninstall --cask api-key-health-checker
25+
```
26+
27+
Remove app data:
28+
29+
```bash
30+
brew uninstall --cask --zap api-key-health-checker
31+
```
1232

1333
## Download
1434

1535
Releases: https://github.com/nbox/API-Key-Health-Checker/releases
1636

1737
## macOS Gatekeeper
1838

19-
⚠️ macOS may block unsigned builds downloaded from GitHub. If you trust the app, remove the quarantine attribute:
39+
⚠️ macOS may block unsigned builds downloaded from GitHub. If you see the message "app is damaged and can't be opened. You should move it to the Trash", run:
2040

2141
```bash
2242
xattr -dr com.apple.quarantine "/Applications/API Key Health Checker.app"

README.ru.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,36 @@ GitHub: https://github.com/nbox/API-Key-Health-Checker
1010

1111
Десктопное приложение для проверки API-ключей популярных сервисов и пакетных проверок с лимитами и отчетами. Поддерживает OpenAI (ChatGPT), Google Gemini, YouTube Data API и Custom эндпоинты.
1212

13+
![Screenshot](assets/screenshot.png)
14+
15+
## 🍺 Homebrew (macOS)
16+
17+
Установка:
18+
19+
```bash
20+
brew install --cask nbox/tap/api-key-health-checker
21+
```
22+
23+
Полное удаление данных:
24+
25+
```bash
26+
brew uninstall --cask --zap api-key-health-checker
27+
```
28+
1329
## Скачать
30+
1431
Релизы: https://github.com/nbox/API-Key-Health-Checker/releases
1532

1633
## macOS Gatekeeper
1734

18-
⚠️ macOS может блокировать неподписанные сборки, скачанные с GitHub. Если вы доверяете приложению, удалите атрибут карантина:
35+
⚠️ macOS может блокировать неподписанные сборки, скачанные с GitHub. Если вы увидели сообщение "app is damaged and can't be opened. You should move it to the Trash", воспользуйтесь командой:
1936

2037
```bash
2138
xattr -dr com.apple.quarantine "/Applications/API Key Health Checker.app"
2239
```
2340

2441
## Возможности
42+
2543
- Адаптеры: OpenAI, Gemini, YouTube, Custom
2644
- Пакетные проверки с параллельностью, случайной задержкой (jitter), ретраями, глобальным лимитом RPS
2745
- Несколько параллельных запусков с логами в реальном времени, статистикой и сводкой
@@ -30,47 +48,51 @@ xattr -dr com.apple.quarantine "/Applications/API Key Health Checker.app"
3048
- Языки UI: English (по умолчанию), Русский, Español
3149

3250
## Безопасность и приватность
51+
3352
- Ключи отправляются только в выбранный API
3453
- Телеметрии нет
3554
- Используйте только ключи, которыми вы владеете или имеете право пользоваться
3655
- Полный экспорт сохраняет ключи в открытом виде (без шифрования). Используйте осторожно.
3756

3857
## Требования
58+
3959
- Node.js 20+
4060
- npm
4161

4262
## Быстрый старт
63+
4364
```bash
4465
npm install
4566
npm run dev
4667
```
4768

48-
## Скриншот
49-
50-
![Место для скриншота](assets/screenshot.png)
51-
5269
## Сборка
70+
5371
```bash
5472
git clone https://github.com/nbox/API-Key-Health-Checker.git
5573
cd API-Key-Health-Checker
5674
npm install
5775
npm run build
5876
npm run dist
5977
```
78+
6079
Сборочные артефакты записываются в `dist/`.
6180
DMG: `release/API Key Health Checker-1.0.0-{arch}.dmg`.
6281
macOS: запускайте `npm run dist` на macOS — получите `.dmg` в `release/`.
6382
Windows: запускайте `npm run dist` на Windows — получите установщик `.exe` в `release/`.
6483

6584
## GitHub Actions release
85+
6686
- При пуше в `main` или теге `v*`
6787
- Сборка для macOS, Windows, Linux
6888
- Создается GitHub Release с артефактами
6989

7090
## Пользовательский сервис
91+
7192
Используйте Custom адаптер, чтобы задать base URL, path, тип авторизации (bearer/header/query) и коды успешных ответов.
7293

7394
## Структура проекта
95+
7496
- `src/main`: основной процесс Electron и движок проверок
7597
- `src/renderer`: UI (React + Tailwind)
7698
- `src/shared`: общие типы и утилиты

0 commit comments

Comments
 (0)