Skip to content

Commit

Permalink
Update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
mikebronner committed Apr 5, 2016
1 parent 6a50499 commit afcf373
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 11 deletions.
12 changes: 10 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,21 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- Add facade(s) for use in views.
- Detect through subscription create when a user had previously unsubscribed (churn), then resubscribes (unchurn).
(This is already detected in subscription update.)
- Filter any incoming webhook events that are in test mode.
- Filter any incoming web-hook events that are in test mode.

## [0.5.3] - 4 Apr 2016
### Added
- configuration setting to disable the default-bundled tracking hooks.

## [0.5.2] - 16 Jan 2016
### Fixed
- event listeners to properly detect new laravel 5.2 events.

## [0.5.1] - 11 Jan 2016
### Fixed
- event listener to work with Laravel 5.2 core events.

## [0.4.10 - 0.4.12] - 28 OCt 2015
## [0.4.10 - 0.4.12] - 28 Oct 2015
### Added
- tracking of robots, if a browser isn't detected, and it is confirmed as a robot.

Expand Down
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,34 @@ existing routes.
```sh
composer require genealabs/laravel-mixpanel:0.4.14
```

2. Add the service provider entry in `config\app.php`:
```php
'GeneaLabs\LaravelMixpanel\Providers\LaravelMixpanelServiceProvider',
```

## Configuration
1. If you are using Laravel 5.2 or above, add the following entry to `config/auth.php`. Be sure to use the correct
namespace for your application. (Yes, this is a duplicate of `providers.users.model`, but necessary for now, in case
1. If you are using Laravel 5.2 or above, add the following entry to `config/auth.php`. Be sure to use the correct
namespace for your application. (Yes, this is a duplicate of `providers.users.model`, but necessary for now, in case
a different driver is used.
```php
'model' => App\User::class,
```

2. Update your `.env` file with your MixPanel token:

2. Update your `.env` file with your MixPanel token (it will automatically be
picked up by the in-built configuration):
```
MIXPANEL_TOKEN=xxxxxxxxxxxxxxxxxxxxxx
```

3. Load the token in the services configuration (`config\services.php`):
3. If you want to disable the in-built default tracking and implement your own,
add the following to your services configuration (`config\services.php`):
```php
'mixpanel' => [
'token' => env('MIXPANEL_TOKEN'),
'enable-default-tracking' => false,
],
```
Disabling the default hooks will not disable the Stripe web-hook functionality.

4. If to track the user's names, make sure a `name` attribute is available on your user model. For example, if you only
have a `username` field that contains the users' first and last names, you could add the following to your user model:
Expand All @@ -56,8 +59,8 @@ existing routes.
return $next($request);
}
```
For Laravel 5.2:

For Laravel 5.2+:
```php
protected $except = [
'genealabs/laravel-mixpanel/*',
Expand Down

0 comments on commit afcf373

Please sign in to comment.