Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SebKay committed Dec 9, 2021
1 parent 2b1f4e4 commit 81d74ff
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Run the following command to install Touchstone in your project:
composer require sebkay/touchstone --dev
```

---

## Usage

### 1.) Setup
Expand Down Expand Up @@ -97,6 +99,25 @@ You can run either all of your tests or a single testsuite with the following co
./vendor/bin/touchstone test --type=integration
```

### 4.) Configuration

You can configure certain things by creating a `config.touchstone.php` file in the root of your project.

Here's how to set the directories for where your tests are located:

```php
<?php
return [
'directories' => [
'all' => 'tests',
'unit' => 'tests/Unit',
'integration' => 'tests/Integration',
],
];
```

---

## Composer Scripts

You can create Composer scripts so you don't need to memorise the above commands.
Expand Down Expand Up @@ -130,6 +151,8 @@ composer touchstone:unit
composer touchstone:integration
```

---

## Troubleshooting

### Tests Won't Run
Expand Down

0 comments on commit 81d74ff

Please sign in to comment.