Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bencroker committed Oct 15, 2024
1 parent 142454f commit 3c090a8
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Datastar PHP

A set of PHP helper classes for working with Datastar with zero dependencies.
A set of PHP helper classes for working with [Datastar](https://data-star.dev/), with zero dependencies.

## License

Expand All @@ -12,7 +12,7 @@ This plugin requires PHP 8.0.0 or later.

## Installation

Install using composer.
Install using composer or download and require the classes manually.

```shell
composer require putyourlightson/datastar-php
Expand Down Expand Up @@ -48,8 +48,10 @@ use putyourlightson\datastar\DatastarResponse;

$response = new DatastarResponse();

// Sends the Datastar event output to the browser.
$response->sendEvent($event);
// Sends Datastar events to the browser.
$response->sendEvent($event1);
$response->sendEvent($event2);
$response->sendEvent($event3);
```

---
Expand Down

0 comments on commit 3c090a8

Please sign in to comment.