From 9ec4bdade1ec6123e79619246dcabad7b8025f76 Mon Sep 17 00:00:00 2001 From: Sam Jones Date: Sun, 18 May 2025 22:23:44 +0100 Subject: [PATCH] docs: document Segment fake usage --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index a2d2ac2..a6a4729 100644 --- a/README.md +++ b/README.md @@ -258,6 +258,24 @@ disabled then the exception will be thrown. ./vendor/bin/pest ``` +### Using `Segment::fake()` in tests + +To prevent real HTTP requests when running your own test suite, call +`Segment::fake()` before executing the code under test. This swaps the +Segment service with a fake that records events and identity calls. You can +then use assertion helpers to verify what was sent: + +```php +use SlashEquip\LaravelSegment\Facades\Segment; + +Segment::fake(); + +// Code that should trigger Segment events + +Segment::assertTracked('User Signed Up'); +Segment::assertIdentified(); +``` + ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.