Skip to content

Commit b5bdb70

Browse files
author
Алексей Тихомиров
committed
docs: update README with current information and add Russian translation
- Update English README with accurate test results (69 tests, 130 assertions) - Fix code coverage section - note that PCOV/Xdebug is required - Add Docker commands for running tests in Docker environment - Add link to example plugin (wp-queue-example-plugin) - Expand example plugin section with detailed features - Add link to Russian translation in English README - Create complete Russian translation (README.ru.md) - Include all features, installation, quick start, API docs - Add Russian examples and explanations
1 parent b04cf0d commit b5bdb70

2 files changed

Lines changed: 487 additions & 19 deletions

File tree

README.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@
2222
<a href="#installation">Installation</a> •
2323
<a href="#quick-start">Quick Start</a> •
2424
<a href="#admin-ui">Admin UI</a> •
25-
<a href="#wp-cli">WP-CLI</a> •
26-
<a href="#rest-api">REST API</a>
25+
<a href="#rest-api">REST API</a> •
26+
<a href="#testing">Testing</a> •
27+
<a href="README.ru.md">🇷🇺 Русский</a>
2728
</p>
2829

2930
---
@@ -392,48 +393,61 @@ add_action('wp_queue_schedule', fn($s) => $s->job(MyHourlyTask::class));
392393

393394
## Testing
394395

395-
WP Queue использует CI-first подход к тестированию.
396+
WP Queue uses a CI-first testing approach with comprehensive test coverage.
396397

397-
### Unit Tests (локально)
398+
### Unit Tests (Local)
398399

399-
Быстрые изолированные тесты без WordPress окружения:
400+
Fast isolated tests without WordPress environment:
400401

401402
```bash
402403
composer test:unit
403404
```
404405

406+
**Results:** 69 tests, 130 assertions ✅
407+
405408
### E2E Tests (GitHub Actions)
406409

407-
Интеграционные тесты с реальным WordPress запускаются автоматически в CI:
410+
Integration tests with real WordPress run automatically in CI:
408411

409412
- ✅ WordPress latest (6.7+) + PHP 8.3
410413
- ✅ WordPress 6.7 + PHP 8.3
411414

412-
E2E тесты выполняются при каждом push в `main`/`develop` ветки и в pull requests.
415+
E2E tests run on every push to `main`/`develop` branches and in pull requests.
413416

414-
### Проверка кода
417+
### Code Quality
415418

416419
```bash
417-
# С покрытием кода
418-
composer test:coverage
419-
420-
# Проверка стиля кода
420+
# Code style check
421421
composer lint
422+
423+
# Run all tests
424+
composer test
425+
```
426+
427+
**Note:** Code coverage requires PCOV or Xdebug extension. In Docker environments, use:
428+
429+
```bash
430+
docker exec wp_site-php composer lint
431+
docker exec wp_site-php composer test:unit
422432
```
423433

424-
Подробнее: [tests/README.md](tests/README.md)
434+
See: [tests/README.md](tests/README.md)
425435

426436
## Example Plugin
427437

428438
See a complete working example: **[wp-queue-example-plugin](https://github.com/rwsite/wp-queue-example-plugin)**
429439

430-
The example demonstrates:
440+
The example plugin demonstrates:
441+
442+
- ✅ Creating custom jobs with PHP 8 attributes
443+
- ✅ Job scheduling with different intervals
444+
- ✅ Error handling and retries
445+
- ✅ Chain and batch processing
446+
- ✅ Queue management and monitoring
447+
- ✅ REST API integration
448+
- ✅ WP-CLI commands
431449

432-
- Creating custom jobs
433-
- Using PHP 8 attributes
434-
- Scheduling jobs
435-
- Handling failures
436-
- Chain and batch processing
450+
Perfect for learning how to integrate WP Queue into your WordPress plugins!
437451

438452
## License
439453

0 commit comments

Comments
 (0)