diff --git a/README.md b/README.md index 02a7bdd..2e98d4a 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,19 @@ -# PHP Library Template -A template repository for PHP libraries. +# PHP Observer +PHP Observer is a library for PHP to implement the [observer pattern](https://en.wikipedia.org/wiki/Observer_pattern). ## Requirements -* [Bash](https://www.gnu.org/software/bash/) -* [Git](https://git-scm.com/) -* [direnv](https://direnv.net/) -* [Docker](https://www.docker.com/) +PHP Observer has the following requirements: -## Installation -```console -./install.sh library-name -``` +* PHP >= 7.3 -## Development Environment -Start up my development environment: -```console -laradockctl my:up -``` - -Shut down my development environment: +## Installation +Execute the Composer `require` command: ```console -laradockctl my:down +composer require ngmy/observer ``` -And more commands: -```console -laradockctl --help -``` +## Documentation +Please see the [API documentation](https://ngmy.github.io/php-observer/api/). ## License -PHP Library Template is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT). +PHP Observer is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).