Skip to content

Commit

Permalink
Update markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Kristories committed Oct 9, 2018
1 parent a1c60a1 commit e29c5e4
Showing 1 changed file with 62 additions and 1 deletion.
63 changes: 62 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,62 @@
# Nova QR Code
# Nova QR Code

A Laravel Nova field to generate QR Code.

## Installation

You can install the Nova field in to a [Laravel](http://laravel.com) app that uses [Nova](http://nova.laravel.com) via composer :

```cli
composer require kristories/nova-qrcode-field
```

## Usage

#### Basic

```php
Qrcode::make('QR Code')
->text('http://laravel.com')
```

![Basic](https://i.imgur.com/V15fjwl.png)

#### With logo

```php
Qrcode::make('QR Code')
->text('http://laravel.com')
->logo('http://source.to/logo.png')
```

![Logo](https://i.imgur.com/YFlAvo3.png)

#### With background

```php
Qrcode::make('QR Code')
->text('http://laravel.com')
->background('http://source.to/background.png')
```

![Background](https://i.imgur.com/nAbuKCc.png)

#### With logo & background

```php
Qrcode::make('QR Code')
->text('http://laravel.com')
->logo('http://source.to/logo.png')
->background('http://source.to/background.png')
```

![Logo & background](https://i.imgur.com/ppVi4jn.png)

## Credits

- [vue-qr](https://github.com/Binaryify/vue-qr)
- [Awesome-qr.js](https://github.com/SumiMakito/Awesome-qr.js)

## License

The MIT License (MIT).

0 comments on commit e29c5e4

Please sign in to comment.