Skip to content

Commit 10aa40b

Browse files
author
ziming
committed
add some useful references to readme to before I tag 1.0
1 parent 9f11dc3 commit 10aa40b

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

+20-7
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@
55
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ziming/laravel-statsig/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ziming/laravel-statsig/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
66
[![Total Downloads](https://img.shields.io/packagist/dt/ziming/laravel-statsig.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-statsig)
77

8-
Laravel Package for Statsig. A Feature Gate & A/B Testing Platform with a somewhat decent free tier.
8+
Laravel Package for Statsig. A Feature Gate & A/B Testing Platform with a somewhat decent free tier
99

10-
This package is still very early in development & likely not ready for production use yet.
11-
I have only just started using it in production on 2 small sites currently.
10+
This package is still very early in development, but I have used it on a few small production sites for a while already.
1211

13-
Use at your own risk if you want to try it now. But if you have used in production, it would be great to let me know :)
12+
If you have used in production, it would be great to let me know any feedback :)
1413

1514
It is basically a wrapper around the [Statsig PHP SDK](https://docs.statsig.com/server/phpSDK)
1615

@@ -20,7 +19,7 @@ The following features are being considered for the future. If any of it interes
2019

2120
- New Adapters
2221
- New Middlewares
23-
- Convenience Traits & Methods
22+
- More Convenience Traits & Methods
2423
- HTTP & Console API support
2524
- Octane/Vapor/Serverless Support (Probably far in the future)
2625

@@ -120,8 +119,8 @@ LaravelStatsigUserConfiguration::setConversionCallable(function (User $laravelUs
120119

121120
// Lastly you can also use LaravelStatsigEvent instead of StatsigEvent
122121
// as it accepts a laravel user object
123-
// I recommend the object action event naming framework
124-
// https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/
122+
// See Useful References at the end of the read me for some best practices to follow for events naming conventions
123+
125124
$statsigEvent = new LaravelStatsigEvent('event_name');
126125

127126
// You can also use this convenience method
@@ -158,6 +157,20 @@ Like the blade directive, currently it can only be used if the user is logged in
158157
```bash
159158
composer test
160159
```
160+
## Userful References
161+
162+
Below are links to some good reads that I think would benefit you in getting started:
163+
164+
### Feature Gates
165+
- https://www.statsig.com/blog/feature-gates-101
166+
167+
### Sample Sizes
168+
- https://blog.statsig.com/you-dont-need-large-sample-sizes-to-run-a-b-tests-6044823e9992
169+
- https://www.statsig.com/blog/intro-to-sample-size
170+
171+
### Event Naming Best Practices
172+
- https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/
173+
- https://davidwells.io/blog/clean-analytics
161174

162175
## Changelog
163176

0 commit comments

Comments
 (0)