Skip to content

Commit e363573

Browse files
author
antoine
committed
Update Readme
1 parent 0e85a7b commit e363573

File tree

1 file changed

+3
-60
lines changed

1 file changed

+3
-60
lines changed

README.md

Lines changed: 3 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,11 @@
22

33
[![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)
44
[![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)
5-
[![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)
65
[![Total Downloads](https://img.shields.io/packagist/dt/code16/laravel-content-renderer.svg?style=flat-square)](https://packagist.org/packages/code16/laravel-content-renderer)
76

8-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
9-
10-
## Support us
11-
12-
[<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)
13-
14-
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).
15-
16-
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).
7+
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.
8+
For security reasons the content is not directly compiled in blade, instead it replace components with `<x-dynamic-component>` tag and pass HTML attributes.
9+
All attributes passed to component are strings. Attributes starting with `:` are not evaluated.
1710

1811
## Installation
1912

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

26-
You can publish and run the migrations with:
27-
28-
```bash
29-
php artisan vendor:publish --tag="laravel-content-renderer-migrations"
30-
php artisan migrate
31-
```
32-
33-
You can publish the config file with:
34-
35-
```bash
36-
php artisan vendor:publish --tag="laravel-content-renderer-config"
37-
```
38-
39-
This is the contents of the published config file:
40-
41-
```php
42-
return [
43-
];
44-
```
45-
46-
Optionally, you can publish the views using
47-
48-
```bash
49-
php artisan vendor:publish --tag="laravel-content-renderer-views"
50-
```
51-
52-
## Usage
53-
54-
```php
55-
$laravelContentRenderer = new Code16\LaravelContentRenderer();
56-
echo $laravelContentRenderer->echoPhrase('Hello, Code16!');
57-
```
58-
5919
## Testing
6020

6121
```bash
6222
composer test
6323
```
6424

65-
## Changelog
66-
67-
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
68-
69-
## Contributing
70-
71-
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
72-
73-
## Security Vulnerabilities
74-
75-
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
76-
77-
## Credits
78-
79-
- [code16](https://github.com/code16)
80-
- [All Contributors](../../contributors)
81-
8225
## License
8326

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

0 commit comments

Comments
 (0)