Skip to content

Commit

Permalink
Merge pull request #1 from viktigpetterr/dev
Browse files Browse the repository at this point in the history
Dev
  • Loading branch information
viktigpetterr authored Feb 21, 2021
2 parents 196137a + 35604b7 commit 07aaad2
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 07aaad2

Please sign in to comment.