Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
antoine committed Jan 17, 2024
1 parent 0e85a7b commit e363573
Showing 1 changed file with 3 additions and 60 deletions.
63 changes: 3 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,11 @@

[![Latest Version on Packagist](https://img.shields.io/packagist/v/code16/laravel-content-renderer.svg?style=flat-square)](https://packagist.org/packages/code16/laravel-content-renderer)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/code16/laravel-content-renderer/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/code16/laravel-content-renderer/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/code16/laravel-content-renderer/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/code16/laravel-content-renderer/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/code16/laravel-content-renderer.svg?style=flat-square)](https://packagist.org/packages/code16/laravel-content-renderer)

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/laravel-content-renderer.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-content-renderer)

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).
This package is used internally for our projects (e.g. [Sharp](https://github.com/code16/sharp)). It allows to render blade `<x-` components inside HTML content.
For security reasons the content is not directly compiled in blade, instead it replace components with `<x-dynamic-component>` tag and pass HTML attributes.
All attributes passed to component are strings. Attributes starting with `:` are not evaluated.

## Installation

Expand All @@ -23,62 +16,12 @@ You can install the package via composer:
composer require code16/laravel-content-renderer
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag="laravel-content-renderer-migrations"
php artisan migrate
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag="laravel-content-renderer-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="laravel-content-renderer-views"
```

## Usage

```php
$laravelContentRenderer = new Code16\LaravelContentRenderer();
echo $laravelContentRenderer->echoPhrase('Hello, Code16!');
```

## Testing

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [code16](https://github.com/code16)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 comments on commit e363573

Please sign in to comment.