Skip to content

Commit b277543

Browse files
committed
Update "Getting Started" documentation
1 parent 573ef6f commit b277543

File tree

2 files changed

+19
-32
lines changed

2 files changed

+19
-32
lines changed

docs/getting-started.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Getting Started
22

3-
Testo is an extensible testing framework built on a lightweight core with a middleware system.
4-
It gives you full control over your testing environment while keeping the familiar PHP syntax you already know.
53

64
## Installation
75

@@ -11,9 +9,12 @@ Install Testo via Composer:
119
composer require --dev testo/testo
1210
```
1311

14-
::: tip Requirements
15-
PHP 8.3 or higher
16-
:::
12+
<p style="display: flex; gap: 8px;">
13+
<a href="https://packagist.org/packages/testo/testo"><img src="https://img.shields.io/packagist/php-v/testo/testo.svg?style=flat-square&logo=php" alt="PHP" style="display: inline-block;"></a>
14+
<a href="https://packagist.org/packages/testo/testo"><img src="https://img.shields.io/packagist/v/testo/testo.svg?style=flat-square&logo=packagist" alt="Latest Version on Packagist" style="display: inline-block;"></a>
15+
<a href="https://github.com/php-testo/testo/blob/1.x/LICENSE.md"><img src="https://img.shields.io/packagist/l/testo/testo.svg?style=flat-square" alt="License" style="display: inline-block;"></a>
16+
<a href="https://packagist.org/packages/testo/testo/stats"><img src="https://img.shields.io/packagist/dt/testo/testo.svg?style=flat-square" alt="Total Downloads" style="display: inline-block;"></a>
17+
</p>
1718

1819
## Configuration
1920

@@ -90,10 +91,10 @@ final class CalculatorTest
9091

9192
### Key Points
9293

93-
- Use the `#[Test]` attribute to mark test methods
94-
- Test classes don't need to extend any base class
95-
- Use `Assert` class for assertions (`same`, `true`, `false`, `null`, `contains`, `instanceOf`, etc.)
96-
- Testo provides multiple attributes to extend testing capabilities (retry policies, exception handling, and more)
94+
- The `#[Test]` attribute is used to mark test methods.
95+
- Test classes don't need to inherit from a base class.
96+
- Use the `Assert` facade for assertions and `Expect` for expectations.
97+
- Testo provides multiple attributes to extend testing capabilities (retry policies, exception handling, and more).
9798

9899
## Running Tests
99100

@@ -114,10 +115,3 @@ The plugin provides:
114115
- Navigation between test and implementation code
115116
- Test result visualization
116117
- Debugging support
117-
118-
## Next Steps
119-
120-
- Learn about [CLI options](/docs/cli-reference) for filtering and running tests
121-
- Explore [Events system](/docs/events) for extending test behavior
122-
- Understand [Test filtering](/docs/filtering) capabilities
123-
- Try the [Sample module](/docs/sample-module) for parameterized testing with data providers

ru/docs/getting-started.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# Начало работы
22

3-
Testo — это расширяемый фреймворк тестирования, построенный на легковесном ядре с системой middleware.
4-
Он даёт вам полный контроль над средой тестирования, сохраняя привычный синтаксис PHP.
5-
63
## Установка
74

85
Установите Testo через Composer:
@@ -11,9 +8,12 @@ Testo — это расширяемый фреймворк тестирован
118
composer require --dev testo/testo
129
```
1310

14-
::: tip Требования
15-
PHP 8.3 или выше
16-
:::
11+
<p style="display: flex; gap: 8px;">
12+
<a href="https://packagist.org/packages/testo/testo"><img src="https://img.shields.io/packagist/php-v/testo/testo.svg?style=flat-square&logo=php" alt="PHP" style="display: inline-block;"></a>
13+
<a href="https://packagist.org/packages/testo/testo"><img src="https://img.shields.io/packagist/v/testo/testo.svg?style=flat-square&logo=packagist" alt="Latest Version on Packagist" style="display: inline-block;"></a>
14+
<a href="https://github.com/php-testo/testo/blob/1.x/LICENSE.md"><img src="https://img.shields.io/packagist/l/testo/testo.svg?style=flat-square" alt="License" style="display: inline-block;"></a>
15+
<a href="https://packagist.org/packages/testo/testo/stats"><img src="https://img.shields.io/packagist/dt/testo/testo.svg?style=flat-square" alt="Total Downloads" style="display: inline-block;"></a>
16+
</p>
1717

1818
## Конфигурация
1919

@@ -90,9 +90,9 @@ final class CalculatorTest
9090

9191
### Ключевые моменты
9292

93-
- Используйте атрибут `#[Test]` для пометки тестовых методов
94-
- Тестовые классы не обязаны наследоваться от базового класса
95-
- Используйте класс `Assert` для утверждений (`same`, `true`, `false`, `null`, `contains`, `instanceOf` и т.д.)
93+
- Атрибут `#[Test]` используется для пометки тестовых методов.
94+
- Тестовые классы не нужно наследовать от базового класса.
95+
- Используйте фасад `Assert` для утверждений и `Expect` для ожиданий.
9696
- Testo предоставляет множество атрибутов для расширения возможностей тестирования (политики повторов, обработка исключений и другое)
9797

9898
## Запуск тестов
@@ -114,10 +114,3 @@ vendor/bin/testo
114114
- Навигацию между тестом и реализацией
115115
- Визуализацию результатов тестов
116116
- Поддержку отладки
117-
118-
## Следующие шаги
119-
120-
- Изучите [опции CLI](/ru/docs/cli-reference) для фильтрации и запуска тестов
121-
- Исследуйте [систему событий](/ru/docs/events) для расширения поведения тестов
122-
- Узнайте о возможностях [фильтрации тестов](/ru/docs/filtering)
123-
- Попробуйте [модуль Sample](/ru/docs/sample-module) для параметризованного тестирования с провайдерами данных

0 commit comments

Comments
 (0)