From e29c5e43d644504b6093ad9b16de5a824926137d Mon Sep 17 00:00:00 2001 From: Wahyu Kristianto Date: Tue, 9 Oct 2018 22:15:58 +0700 Subject: [PATCH] Update markdown --- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 62 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c9a2a51..c289a17 100644 --- a/README.md +++ b/README.md @@ -1 +1,62 @@ -# Nova QR Code \ No newline at end of file +# 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).