Skip to content

Commit

Permalink
More documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kasperhartwich committed Jan 25, 2024
1 parent d759035 commit 4fa9fdc
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ jobs:
run: composer show -D

- name: Execute tests
run: vendor/bin/phpunit
run: composer test
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

This is a client for the [Ticketbutler API](https://lab.ticketbutler.io).

## Requirements
* PHP 8.1
* Laravel =>8.x

## Installation

You can install the package via composer:
Expand All @@ -22,8 +26,22 @@ TICKETBUTLER_TOKEN=your-token
TICKETBUTLER_DOMAIN=example.com
```

If you want to publish the config file you can run:
``` bash
php artisan vendor:publish --tag=ticketbutler
```

## Usage

### General
``` php
use Ticketbutler\Ticketbutler;

$ticketbutler = new Ticketbutler('your-api-token', 'example.com');
$tickets = $ticketbutler->getTickets();
```

### Laravel
``` php
use Ticketbutler\Ticketbutler;

Expand All @@ -39,7 +57,7 @@ class MyController extends Controller
## Testing

``` bash
vendor/bin/phpunit
composer test
```

## Supported API methods
Expand Down
2 changes: 1 addition & 1 deletion src/TicketbutlerServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function boot(): void
{
$this->publishes([
__DIR__.'/../config/ticketbutler.php' => config_path('ticketbutler.php'),
]);
], 'ticketbutler-config');
}

public function register(): void
Expand Down

0 comments on commit 4fa9fdc

Please sign in to comment.