Skip to content
This repository has been archived by the owner on Mar 18, 2024. It is now read-only.

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mattstauffer authored Sep 10, 2018
1 parent 960cd22 commit a126f8e
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,21 @@

JUST GETTING STARTED.

The card:

<img width="396" alt="screen shot 2018-09-06 at 12 13 19 am" src="https://user-images.githubusercontent.com/151829/45134868-a18fb680-b16a-11e8-98c4-f5583c6009da.png">
<img width="398" alt="screen shot 2018-09-06 at 12 13 45 am" src="https://user-images.githubusercontent.com/151829/45134870-a18fb680-b16a-11e8-8192-4e08ce1f0524.png">

The tool:

<img width="1256" alt="screen shot 2018-09-10 at 12 07 39 am" src="https://user-images.githubusercontent.com/151829/45276011-e62e9100-b48d-11e8-8217-481f999f9521.png">


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?


Expand All @@ -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
Expand All @@ -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 [email protected] instead of using the issue tracker.
Expand Down

0 comments on commit a126f8e

Please sign in to comment.