Skip to content

Commit 7b93ae7

Browse files
committed
Update installation instructions to clarify pre-1.0 stability warning and production usage guidelines
1 parent bc67a03 commit 7b93ae7

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

docs/getting-started/installation.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ composer require --dev typephp/typephp
1414

1515
---
1616

17-
## Production Installation (Optional & Advanced)
17+
## Pre-1.0 Stability Warning & Production Usage
1818

19-
If you intend to use TypePHP in production to selectively enforce type contracts on mission-critical domain logic, payment gateways, or security boundaries, install it as a main dependency:
19+
> **Pre-1.0 Stability Warning:** TypePHP is currently in active pre-1.0 development and has not yet reached its stable `v1.0.0` release.
20+
>
21+
> **Do NOT use TypePHP in high-stakes, mission-critical production applications yet.**
22+
>
23+
> TypePHP is strongly recommended for local development, Pest/PHPUnit test suites, and CI/CD build pipelines. If you choose to run TypePHP in non-critical live applications, staging servers, or internal web tools, install it as a main dependency, but be aware of its pre-1.0 status:
2024
2125
```bash
2226
composer require typephp/typephp
@@ -58,7 +62,7 @@ require 'vendor/autoload.php';
5862
// TypePHP is booted and active
5963
```
6064

61-
This means that if you run your application that uses entry point like web frameworks via public index.php file where the `require 'vendor/autoload';` is declared. TypePHP can now transform and typecheck a php file that is included in your configuration.
65+
This means that if you run your application through an entry point like a web framework's `public/index.php` file where `require 'vendor/autoload.php';` is declared, TypePHP automatically transforms and type-checks any PHP files that are whitelisted in your `typephp.php` configuration.
6266

6367
---
6468

0 commit comments

Comments
 (0)