Skip to content

Commit

Permalink
docs: add image and detailed usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Hasan Demir committed Aug 1, 2023
1 parent b12555a commit 05b4487
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Cappadocia Viewer for Laravel
<picture>
<img alt="Cappadocia Viewer for Laravel" src="./art/app.png">
</picture>

[![Latest Version on Packagist](https://img.shields.io/packagist/v/hsndmr/cappadocia-viewer-for-laravel.svg?style=flat-square)](https://packagist.org/packages/hsndmr/cappadocia-viewer-for-laravel)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/hsndmr/cappadocia-viewer-for-laravel/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/hsndmr/cappadocia-viewer-for-laravel/actions?query=workflow%3Arun-tests+branch%3Amain)
Expand All @@ -8,6 +11,8 @@

## Installation

Prior to installing this package, ensure that you have already installed [Cappadocia Viewer](https://github.com/hsndmr/cappadocia-viewer/releases/tag/0.0.2)

You can install the package via composer:

```bash
Expand All @@ -31,6 +36,11 @@ return [
```

## Usage
If you want to send a message manually to Cappadocia Viewer, you can use `cappadocia` method. You can see examples below.

````php
cappadocia('your message')->send(['context' => 'data']);
````

## Testing

Expand Down

0 comments on commit 05b4487

Please sign in to comment.