Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bracketsdigital authored May 13, 2023
1 parent 5e4b3ae commit 8b3baee
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,36 @@ This package was developed using PHP 8, Vue 3, Laravel 10, Nova 4, ckfinder for
- **[Vue3](https://vuejs.org/)**
- **[Nova](https://nova.laravel.com/docs/4.0/installation.html)**
- **[Ckeditor 5 Vue](https://github.com/ckeditor/ckeditor5-vue)**
- **[Ckeditor 5 Vue](https://github.com/ckeditor/ckeditor5-vue)**

## Installation

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

```bash
composer require craft-cloud/nova-ck-light
composer require bracketsdigital/nova-ck-light
```

## Usage

Default editor

```php
use CraftCloud\NovaCkLight\NovaCkLight;
use BracketsDigital\NovaCkLight\NovaCkLight;

NovaCkLight::make('MyFieldName'),
```

Editor options
```php
use CraftCloud\NovaCkLight\NovaCkLight;
use BracketsDigital\NovaCkLight\NovaCkLight;

NovaCkLight::make('MyFieldName')->toolbar(['heading', '|', 'bold', 'italic', 'link']),
```

If you require images without an editor

```php
use CraftCloud\NovaCkLight\NovaCkLight;
use BracketsDigital\NovaCkLight\NovaCkLight;

NovaCkLight::make('MyFieldName')->imageOnly(),
```
Expand All @@ -60,7 +59,7 @@ Please see [CONTRIBUTING](https://github.com/craft-cloud/nova-ck-light/blob/main

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

Expand Down

0 comments on commit 8b3baee

Please sign in to comment.