Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JoppeDC committed Apr 6, 2023
1 parent 7ca97fb commit 2fece8c
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
### Install

To install the SDK you will need to be using [Composer]([https://getcomposer.org/)
in your project. To install it please see the [docs](https://getcomposer.org/download/).
in your project. To install it please see the [composer docs](https://getcomposer.org/download/).

This is the "core" SDK, meaning that all the core logic and models are here.
If you are happy with using the HTTP client we recommend install the SDK
If you are happy with using your own HTTP client, install the SDK
like: [`joppedc/logsnag-php-sdk`](https://github.com/JoppeDC/LogSnag-PHP-SDK)

```bash
Expand All @@ -41,10 +41,7 @@ composer require joppedc/logsnag-php-sdk php-http/curl-client
This will install the library itself along with an HTTP client adapter that uses
cURL as transport method (provided by Httplug). You do not have to use those
packages if you do not want to. The SDK does not care about which transport method
you want to use because it's an implementation detail of your application. You may
use any package that
provides [`php-http/async-client-implementation`](https://packagist.org/providers/php-http/async-client-implementation)
and [`http-message-implementation`](https://packagist.org/providers/psr/http-message-implementation).
you want to use because it's an implementation detail of your application.

### Configuration

Expand Down Expand Up @@ -82,7 +79,7 @@ $payload = new JoppeDc\LogsnagPhpSdk\Contracts\InsightPayload(

$payload->setIcon('😀');

$insight = $this->client->createLog($payload);
$insight = $this->client->createInsight($payload);
```

#### Mutate an insight event
Expand All @@ -96,9 +93,9 @@ $payload = new JoppeDc\LogsnagPhpSdk\Contracts\MutateInsightPayload(

$payload->setIcon('😀');

$insight = $this->client->createLog($payload);
$insight = $this->client->mutateInsight($payload);
```

## Special thanks

- [Logsnag](https://docs.logsnag.com)
- [Logsnag](https://docs.logsnag.com)

0 comments on commit 2fece8c

Please sign in to comment.