diff --git a/README.md b/README.md index df81857..5265e2e 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,48 @@ # PHP Option Type -[](http://travis-ci.org/schmittjoh/php-option) -[](https://scrutinizer-ci.com/g/schmittjoh/php-option/) +This package implements the Option type for PHP! -An Option type for PHP. + + +
+ + +## Motivation The Option type is intended for cases where you sometimes might return a value -(typically an object), and sometimes you might return a base value (typically null) -depending on arguments, or other runtime factors. - -Often times, you forget to handle the case where a base value should be returned. Not intentionally -of course, but maybe you did not account for all possible states of the system; or maybe you -indeed covered all cases, then time goes on, code is refactored, some of these your checks -might become invalid, or incomplete. Suddenly, without noticing, the base value case is not -handled anymore. As a result, you might sometimes get fatal PHP errors telling you that +(typically an object), and sometimes you might return a base value (typically +null) depending on arguments, or other runtime factors. + +Often times, you forget to handle the case where a base value should be +returned. Not intentionally of course, but maybe you did not account for all +possible states of the system; or maybe you indeed covered all cases, then time +goes on, code is refactored, some of these your checks might become invalid, or +incomplete. Suddenly, without noticing, the base value case is not handled +anymore. As a result, you might sometimes get fatal PHP errors telling you that you called a method on a non-object; users might see blank pages, or worse. -On one hand, the Option type forces a developer to consciously think about both cases -(returning a value, or returning a base value). That in itself will already make your code more -robust. On the other hand, the Option type also allows the API developer to provide -more concise API methods, and empowers the API user in how he consumes these methods. +On one hand, the Option type forces a developer to consciously think about both +cases (returning a value, or returning a base value). That in itself will +already make your code more robust. On the other hand, the Option type also +allows the API developer to provide more concise API methods, and empowers the +API user in how he consumes these methods. + ## Installation -Installation is super-easy via composer: +Installation is super-easy via [Composer](https://getcomposer.org/): ```bash $ composer require phpoption/phpoption ``` -or add it to your `composer.json` file. +or add it by hand to your `composer.json` file. ## Usage