Skip to content

Commit 8b16678

Browse files
committed
Refactor README formatting for improved readability and structure.
1 parent 08eea04 commit 8b16678

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
1-
PHP Typed Values
2-
================
1+
# PHP Typed Values
32

43
A PHP 8.2 library of typed value objects for common PHP data types.
54

65
[![Latest Version on Packagist](https://img.shields.io/packagist/v/georgii-web/php-typed-values.svg?style=flat-square)](https://packagist.org/packages/georgii-web/php-typed-values)
76
[![Tests](https://github.com/georgii-web/php-typed-values/actions/workflows/php.yml/badge.svg)](https://github.com/georgii-web/php-typed-values/actions/workflows/php.yml)
87
[![Total Downloads](https://img.shields.io/packagist/dt/georgii-web/php-typed-values.svg?style=flat-square)](https://packagist.org/packages/georgii-web/php-typed-values)
98

10-
Install
11-
-------
9+
## Install
1210

1311
Using Composer:
1412

1513
```
1614
composer require georgii-web/php-typed-values
1715
```
1816

19-
Usage
20-
-----
17+
## Usage
2118

22-
1. Use existing typed values with validation built in:
19+
20+
#### 1. Use existing typed values with validation built in:
2321

2422
```php
2523
$id = PositiveInt::fromString('123');
@@ -34,15 +32,15 @@ if ($id <= 0) {
3432
}
3533
```
3634

37-
2. Create aliases:
35+
#### 2. Create aliases:
3836

3937
```php
4038
readonly class Id extends PositiveInt {}
4139

4240
Id::fromString('123');
4341
```
4442

45-
3. Create a composite value object from other typed values (nullable values example):
43+
#### 3. Create a composite value object from other typed values (nullable values example):
4644

4745
```php
4846
final class Profile
@@ -83,15 +81,13 @@ $profile = Profile::fromScalars(...[157, 'Tom', null]);
8381
- **No external dependencies** – Pure PHP implementation without requiring third‑party packages.
8482
- **Extendable** – Extendable with custom-typed values and composite value objects.
8583

86-
More information
87-
-------
84+
## More information
8885

8986
See [docs/INSTALL.md](docs/INSTALL.md) for installation instructions.
9087
See [docs/USAGE.md](docs/USAGE.md) for usage examples.
9188
See [docs/DEVELOP.md](docs/DEVELOP.md) for development details.
9289

9390

94-
License
95-
-------
91+
## License
9692

9793
MIT

0 commit comments

Comments
 (0)