Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rahmanramsi committed Jun 18, 2022
1 parent c927c6a commit 22027b9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 47 deletions.
52 changes: 5 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,10 @@
# Filament EditorJs

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org)

# Next generation block styled editor.

![Filament EditorJs](art/banner.png)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/rahmanramsi/filament-editorjs.svg?style=flat-square)](https://packagist.org/packages/rahmanramsi/filament-editorjs)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/rahmanramsi/filament-editorjs/run-tests?label=tests)](https://github.com/rahmanramsi/filament-editorjs/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/rahmanramsi/filament-editorjs/Check%20&%20fix%20styling?label=code%20style)](https://github.com/rahmanramsi/filament-editorjs/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/rahmanramsi/filament-editorjs.svg?style=flat-square)](https://packagist.org/packages/rahmanramsi/filament-editorjs)

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Support us

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/filament-editorjs.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/filament-editorjs)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
[EditorJs](https://editorjs.io/) integration for Filament Admin/Forms.

## Installation

Expand All @@ -26,43 +14,13 @@ You can install the package via composer:
composer require rahmanramsi/filament-editorjs
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag="filament-editorjs-migrations"
php artisan migrate
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag="filament-editorjs-config"
```

This is the contents of the published config file:

```php
return [
];
```

Optionally, you can publish the views using

```bash
php artisan vendor:publish --tag="filament-editorjs-views"
```

## Usage

```php
$editorJs = new rahmanramsi\EditorJs();
echo $editorJs->echoPhrase('Hello, rahmanramsi!');
```
use FilamentEditorJs\Forms\Components\EditorJs;

## Testing
EditorJs::make('content')

```bash
composer test
```

## Changelog
Expand Down
Binary file added art/banner.png
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 22027b9

Please sign in to comment.