diff --git a/readme.md b/readme.md index e49726b..27b4f8f 100644 --- a/readme.md +++ b/readme.md @@ -5,14 +5,21 @@ JUST GETTING STARTED. +The card: + screen shot 2018-09-06 at 12 13 19 am screen shot 2018-09-06 at 12 13 45 am +The tool: + +screen shot 2018-09-10 at 12 07 39 am + + Plans: - [x] Show the latest release on a card and compare it against yours - [x] Add to the card a big icon to show green or red and a link to upgrade if you're red -- [ ] Show all releases in a list in a tool +- [x] Show all releases in a list in a tool - [ ] Add a danger state if there are security issues, maybe? or something clever like that? @@ -24,7 +31,7 @@ You can install the package in to a Laravel app that uses [Nova](https://nova.la composer require tightenco/nova-releases ``` -Next up, you must register the card with Nova. This is typically done in the `cards` method of the `NovaServiceProvider`. +Next up, you may register the card with Nova. This is typically done in the `cards` method of the `NovaServiceProvider`. ```php // in app/Providers/NovaServiceProvider.php @@ -40,6 +47,22 @@ public function cards() } ``` +You can also register the "release history" tool, in the `tools` method of the `NovaServiceProvider`. + +```php +// in app/Providers/NovaServiceProvider.php + +// ... + +public function tools() +{ + return [ + // ... + new \Tightenco\NovaReleases\AllReleases, + ]; +} +``` + ### Security If you discover any security related issues, please email matt@tighten.co instead of using the issue tracker.