Permalink
Browse files

fixed write-good issues to improve readability of readme (#298)

  • Loading branch information...
pkunze authored and freekmurze committed Oct 31, 2017
1 parent 6ab3667 commit 2748d926aeff18d2dab3b83ef395d22766f67e6a
Showing with 13 additions and 11 deletions.
  1. +13 −11 README.md
View
@@ -6,9 +6,10 @@
[![StyleCI](https://styleci.io/repos/61802818/shield)](https://styleci.io/repos/61802818)
[![Total Downloads](https://img.shields.io/packagist/dt/spatie/laravel-activitylog.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-activitylog)
The `spatie/laravel-activitylog` package provides easy to use functions to log the activities of the users of your app. It can also automatically log model events. All activity will be stored in the `activity_log` table.
The `spatie/laravel-activitylog` package provides easy to use functions to log the activities of the users of your app. It can also automatically log model events.
The Package stores all activity in the `activity_log` table.
Here's a litte demo of how you can use it:
Here's a demo of how you can use it:
```php
activity()->log('Look, I logged something');
@@ -43,7 +44,7 @@ Here's an example on [event logging](https://docs.spatie.be/laravel-activitylog/
$newsItem->name = 'updated name';
$newsItem->save();
//updating the newsItem will cause an activity being logged
//updating the newsItem will cause the logging of an activity
$activity = Activity::all()->last();
$activity->description; //returns 'updated'
@@ -71,7 +72,7 @@ You'll find the documentation on [https://docs.spatie.be/laravel-activitylog/v2]
Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the activity log? Feel free to [create an issue on GitHub](https://github.com/spatie/laravel-activitylog/issues), we'll try to address it as soon as possible.
If you've found a bug regarding security please mail [freek@spatie.be](mailto:freek@spatie.be) instead of using the issue tracker.
If you've found a security issue please mail [freek@spatie.be](mailto:freek@spatie.be) instead of using the issue tracker.
## Installation
@@ -91,7 +92,7 @@ php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProv
*Note*: The default migration assumes you are using integers for your model IDs. If you are using UUIDs, or some other format, adjust the format of the subject_id and causer_id fields in the published migration before continuing.
After the migration has been published you can create the `activity_log` table by running the migrations:
After publishing the migration you can create the `activity_log` table by running the migrations:
```bash
@@ -109,13 +110,14 @@ This is the contents of the published config file:
return [
/**
* When set to false, no activities will be saved to database.
* When set to false, activitylog will not
* save any activities to the database.
*/
'enabled' => env('ACTIVITY_LOGGER_ENABLED', true),
/**
* When running the clean-command all recording activites older than
* the number of days specified here will be deleted.
* Running the clean-command will delete all activities
* older than the number of days specified here.
*/
'delete_records_older_than_days' => 365,
@@ -134,16 +136,16 @@ return [
/**
* This model will be used to log activity. The only requirement is that
* it should be or extend the Spatie\Activitylog\Models\Activity model.
* The model used to log the activities.
* It should be or extend the Spatie\Activitylog\Models\Activity model.
*/
'activity_model' => \Spatie\Activitylog\Models\Activity::class,
];
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes.
## Testing

0 comments on commit 2748d92

Please sign in to comment.