Skip to content

Commit 1548722

Browse files
Anton Komarevroshangautam
Anton Komarev
authored andcommitted
refactor(readme) : use proper markdown preset for php code highlights
1 parent 9e9887c commit 1548722

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

+21-11
Original file line numberDiff line numberDiff line change
@@ -18,38 +18,48 @@ Manage your `Laravel Schedule` from a pretty dashboard. Schedule your `Laravel C
1818
#### Installation
1919

2020
`Totem` requires Laravel v5.4 and above. Use composer to install totem to your Laravel project
21-
22-
composer require studio/laravel-totem
21+
22+
```
23+
composer require studio/laravel-totem
24+
```
2325

2426
> Laravel Totem supports auto package discovery for Laravel v5.5, therefore service provider registration is not required in Laravel v5.5
2527
2628
Add `TotemServiceProvider` to the `providers` array of your Laravel v5.4 application's config/app.php
2729

28-
Studio\Totem\Providers\TotemServiceProvider::class,
30+
```php
31+
Studio\Totem\Providers\TotemServiceProvider::class,
32+
```
2933

3034
Once `Laravel Totem` is installed & registered,
3135

3236
- Run the migration
33-
34-
php artisan migrate
35-
37+
38+
```
39+
php artisan migrate
40+
```
41+
3642
- Publish `Totem` assets to your public folder using the following command
37-
38-
php artisan totem:assets
43+
44+
```
45+
php artisan totem:assets
46+
```
3947

4048
#### Configuration
4149

4250
##### Cron Job
4351

4452
This package assumes that you have a good understanding of [Laravel's Task Scheduling](https://laravel.com/docs/5.4/scheduling) and [Laravel Console Commands](https://laravel.com/docs/5.4/artisan#writing-commands). Before any of this works please make sure you have a cron running as follows:
4553

46-
* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1
54+
```
55+
* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1
56+
```
4757

4858
##### Web Dashboard
4959

5060
`Laravel Totem`'s dashboard is inspired by `Laravel Horizon`. Just like Horizon you can configure authentication to `Totem`'s dashboard. Add the following to the boot method of your AppServiceProvider or wherever you might seem fit.
5161

52-
```
62+
```php
5363
use Studio\Totem\Totem;
5464

5565
Totem::auth(function($request) {
@@ -64,7 +74,7 @@ By default Totem's dashboard only works in local environment. To view the dashbo
6474

6575
All artisan commands can be scheduled. If you want to hide a command from Totem make sure you have the `hidden` attribute set to true in your command. For e.g.
6676

67-
```
77+
```php
6878
protected $hidden = true;
6979
```
7080

0 commit comments

Comments
 (0)