Skip to content

Commit 64596a1

Browse files
committed
[refactor] update docs
1 parent d5e8e5d commit 64596a1

File tree

3 files changed

+45
-22
lines changed

3 files changed

+45
-22
lines changed

.editorconfig

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ trim_trailing_whitespace = true
1010

1111
[*.md]
1212
trim_trailing_whitespace = false
13+
indent_size = 2
1314

1415
[*.yml]
1516
indent_style = space
16-
indent_size = 2
17+
indent_size = 2

CHANGELOG.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,55 @@
33
This project follows [Semantic Versioning](CONTRIBUTING.md).
44

55
---
6-
### v7.0.0 - 04/17/2020
6+
7+
## v8.0.0 - 10/30/2020
8+
9+
- Add Laravel 8.x Support
10+
- Update Change Log
11+
12+
## v7.0.0 - 04/17/2020
13+
714
- Add Laravel 7.x Support
815
- Update Change Log
916

10-
### v6.0.0 - 10/26/2019
17+
## v6.0.0 - 10/26/2019
18+
1119
- Add Laravel 6.x Support
1220
- Update Change Log
1321

14-
### v5.0.0 - 03/03/2019
22+
## v5.0.0 - 03/03/2019
23+
1524
- Add Laravel 5.8 Support
1625
- Update Change Log
1726

18-
### v4.0.3 - 01/24/2019
27+
## v4.0.3 - 01/24/2019
28+
1929
- Fix constant definition typo in service provider
2030

21-
### v4.0.2 - 12/20/2018
31+
## v4.0.2 - 12/20/2018
32+
2233
- Add support for configurable DB connection
2334
- Cache table prefix to avoid multiple and frequent DB queries
2435

25-
### v4.0.1 - 11/08/2018
36+
## v4.0.1 - 11/08/2018
37+
2638
- Fix table prefix issue that surfaced with Laravel 5.7.12
2739
- Fix foreign key database migrations
2840

29-
### v4.0.0 - 09/05/2018
41+
## v4.0.0 - 09/05/2018
42+
3043
- Add Laravel 5.7 compatiblity
3144
- Use null coalescing operator in blade file instead of or operator
3245
- Update changelog and readme
3346

34-
### v3.0.0 - 02/27/2018
47+
## v3.0.0 - 02/27/2018
48+
3549
- Add support for Laravel 5.6
3650

37-
### v2.0.0 - 09/03/2017
51+
## v2.0.0 - 09/03/2017
52+
3853
- Add support for Laravel 5.5
3954

40-
### v1.0.0 - 09/03/2017
55+
## v1.0.0 - 09/03/2017
56+
4157
- Initial stable release for Laravel 5.4

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ Manage your `Laravel Schedule` from a pretty dashboard. Schedule your `Laravel C
1616

1717
#### Compatiblity Matrix
1818

19-
|<span align="left">Laravel</span> |<span align="left">Totem</span>|
20-
|:-------|----------:|
21-
|7.x | 7.x |
22-
|6.x | 6.x |
23-
|5.8 | 5.x |
24-
|5.7 | 4.x |
25-
|5.6 | 3.x |
26-
|5.5 | 2.x |
27-
|5.4 | 1.x |
19+
| <span align="left">Laravel</span> | <span align="left">Totem</span> |
20+
| :-------------------------------- | ------------------------------: |
21+
| 7.x | 7.x |
22+
| 6.x | 6.x |
23+
| 5.8 | 5.x |
24+
| 5.7 | 4.x |
25+
| 5.6 | 3.x |
26+
| 5.5 | 2.x |
27+
| 5.4 | 1.x |
2828

2929
#### Installing
3030

@@ -80,7 +80,7 @@ This package assumes that you have a good understanding of [Laravel's Task Sched
8080

8181
##### Web Dashboard
8282

83-
`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.
83+
`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.
8484

8585
```php
8686
use Studio\Totem\Totem;
@@ -98,6 +98,7 @@ By default Totem's dashboard only works in local environment. To view the dashbo
9898
By default `Totem` outputs all Artisan commands on the Create/Edit tasks. To make this dropdown more concise there is a filter config feature that can be set in the `totem.php` config file.
9999

100100
Example filters
101+
101102
```php
102103
'artisan' => [
103104
'command_filter' => [
@@ -147,6 +148,7 @@ If your command requires arguments or options please use the optional command pa
147148
```text
148149
name=john.doe --greetings='Welcome to the new world'
149150
```
151+
150152
In the example above, name is an argument while greetings is an option
151153

152154
#### Console Command
@@ -160,15 +162,19 @@ php artisan schedule:list
160162
### Screenshots
161163

162164
##### Task List
165+
163166
<img src="https://github.com/codestudiohq/laravel-totem/blob/1.0/public/img/screenshots/tasks.png?raw=true" alt="Task List"/>
164167

165168
##### Task Details
169+
166170
<img src="https://github.com/codestudiohq/laravel-totem/blob/1.0/public/img/screenshots/task-details.png?raw=true" alt="Task List"/>
167171

168172
##### Edit Task
173+
169174
<img src="https://github.com/codestudiohq/laravel-totem/blob/1.0/public/img/screenshots/edit-task.png?raw=true" alt="Task List"/>
170175

171176
##### Artisan Command to view scheduled tasks
177+
172178
<img src="https://github.com/codestudiohq/laravel-totem/blob/1.0/public/img/screenshots/artisan.png?raw=true" alt="Task List"/>
173179

174180
## Changelog
@@ -192,4 +198,4 @@ Bug reports, feature requests, and pull requests can be submitted by following o
192198

193199
This software is released under the [MIT](LICENSE) License.
194200

195-
© 2020 Roshan Gautam, All rights reserved.
201+
© 2020 Roshan Gautam, All rights reserved.

0 commit comments

Comments
 (0)