Skip to content

Commit 579a60d

Browse files
committed
#2 Update README.md: add screenshot and more links
1 parent 016a261 commit 579a60d

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Nova HTML Card
22

3-
Adds a card to the Nova dashboard with any arbitrary HTML content.
3+
[![Latest Stable Version](https://poser.pugx.org/idf/nova-html-card/v/stable)](https://packagist.org/packages/idf/nova-html-card)
4+
[![Total Downloads](https://poser.pugx.org/idf/nova-html-card/downloads)](https://packagist.org/packages/idf/nova-html-card)
5+
6+
Adds a card to the Laravel Nova dashboard with any arbitrary HTML content.
7+
8+
![image](https://user-images.githubusercontent.com/5278175/60386958-35899080-9aa5-11e9-8e1f-b29e95c80d2c.png)
49

510
## Installation
611

@@ -10,7 +15,9 @@ You can install the package in to a Laravel app that uses [Nova](https://nova.la
1015
composer require idf/nova-html-card
1116
```
1217

13-
Then, register your new link in the `cards` method of the `NovaServiceProvider` or your `ResourceTool` class.
18+
## Usage
19+
20+
[Register your new card](https://nova.laravel.com/docs/2.0/customization/cards.html#registering-cards).
1421

1522
```php
1623
public function cards()
@@ -23,10 +30,23 @@ public function cards()
2330
}
2431
```
2532

26-
## Options
33+
### Options
2734
- Set content
2835
- `->html('string')`: Set HTML or plain content.
2936
- `->markdown('string')`: Set Markdown content that will be converted into HTML.
3037
- `->view('path.to.view', [])`: Specify blade view file and optionally pass an array of data to view.
3138
- Styling
32-
- `->center(true)`: Center card's content.
39+
- `->center(boolean)`: Center card's content.
40+
41+
42+
### Changelog
43+
44+
Please see [Releases](https://github.com/InteractionDesignFoundation/nova-html-card/releases) for more information on what has changed recently.
45+
46+
## Contributing
47+
48+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
49+
50+
## License
51+
52+
The MIT License (MIT). Please see [License File](LICENSE) for more information.

0 commit comments

Comments
 (0)