Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
# Conflicts:
#	src/PrezetServiceProvider.php
  • Loading branch information
benbjurstrom committed May 9, 2024
2 parents 6500a97 + 43b6e97 commit 353d0af
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 1 deletion.
84 changes: 84 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,87 @@ Use this package to transforms your markdown files into SEO-friendly blogs, arti
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/benbjurstrom/prezet/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/benbjurstrom/prezet/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/benbjurstrom/prezet/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/benbjurstrom/prezet/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/benbjurstrom/prezet.svg?style=flat-square)](https://packagist.org/packages/benbjurstrom/prezet)

## Table of contents
- [Quick Start](https://github.com/benbjurstrom/prezet#quick-start)
- [Configuration](https://github.com/benbjurstrom/prezet#configuration)
- [Image Optimization](https://github.com/benbjurstrom/prezet#image-optimization)

## 🚀 Quick start

## Installation

Install with composer:

```bash
composer require benbjurstrom/prezet
```

Add the prezet storage disk in `config/filestem.php`:

```php
'prezet' => [
'driver' => 'local',
'root' => storage_path('content'),
'throw' => false,
],
```

Run the installer:

```bash
php artisan prezet:install
```

Publish the config file with:

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

## Usage

```php
$prezet = new BenBjurstrom\Prezet();
echo $prezet->echoPhrase('Hello, BenBjurstrom!');
```

## 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

- [Ben Bjurstrom](https://github.com/benbjurstrom)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
2 changes: 1 addition & 1 deletion src/Http/Controllers/IndexController.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public function __invoke(Request $request)
$posts = Prezet::GetAllPosts();

return view('prezet::index', [
'posts' => $posts
'posts' => $posts,
]);
}
}

0 comments on commit 353d0af

Please sign in to comment.