Skip to content

Commit

Permalink
Add README.md (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexAzartsev committed Mar 12, 2021
1 parent 7e5a36c commit 29d602f
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Heroicon Nova Field

A Laravel Nova Field for managing icons. [Heroicons](https://heroicons.com/) icons used by default. There is a
possability to use custom icon in svg format. Icon saved as svg html tag into db.

## Installation:

Use composer for installation. Laravel with nova required.

```bash
composer require alexazartsev/heroicon
```

## Usage:

Use it as regular nova field:

```php
use AlexAzartsev\Heroicon\Heroicon;

Heroicon::make('Icon');
```

To use custom or customize existing icon click on `Edit` button and just edit svg code of selected icon:

<img src="screenshots/custom_icon.gif" width="800">

## Support:

[email protected]

## License:

The MIT License (MIT). Please see [License File](LICENSE) for more information.
Binary file added screenshots/custom_icon.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 29d602f

Please sign in to comment.