diff --git a/README.md b/README.md index bed378c..76df23f 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,35 @@ ![Packagist License](https://img.shields.io/packagist/l/viktigpetterr/lunchtime) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/viktigpetterr/lunchtime/PHP%20Composer) -**Setup** -```sh -$ composer install -``` +**Installation** +- ```sh + $ git clone https://github.com/viktigpetterr/bellan.git + ``` +- ```sh + $ cd bellan + ``` +- ```sh + $ composer install + ``` +- ```sh + $ cp bellan.example.yaml bellan.yaml + ``` +- Open `bellan.yaml` and pase your Slack web hook. + + +- ```sh + $ cp working-hours.example.yaml working-hours.yaml + ``` +- ```sh + $ crontab -e + ``` +- Append the line `* * * * * /usr/bin/php /[path]/bellan/Bellan.php 1>> /dev/null 2>&1`. Make sure to change `[path]` to your path! **How to add a restaurant** - - Create restaurant class that extend `Restaurant.php` in `src/restaurants`. - - Implement functions `parse()` and `__toString()`. - - Create test class that extend `RestaurantTest.php` in `tests/restaurants`. - - Implement test functions `testParse()` and `testToString()`. Add a static test file in `tests/static` if needed. + - Create a restaurant class that extend `Restaurant.php` in `src/restaurants`. + - Implement the functions `parse()` and `__toString()`. + - Create a test class that extend `RestaurantTest.php` in `tests/restaurants`. + - Implement the test functions `testParse()` and `testToString()`. Add a static test file in `tests/static` if needed. **Run tests** ```sh