Update README.md

Fix styling

Update README.md

Update README.md

composer updates

wip

Update composer.json

Update README.md

Update CHANGELOG

Update VellumController.php

wip

Update CHANGELOG

Update CHANGELOG

Update README.md

CHANGELOG.md

@@ -1,3 +1,15 @@
 # Changelog
 
 All notable changes to `vellum` will be documented in this file.
+
+## v1.0.1 - 2023-08-02
+
+v1.0.0
+
+## v.1.0.0 - 2023-08-02
+
+Initial Release
+
+## v1.0.0-beta.1 - 2023-08-02
+
+Initial Release

README.md

@@ -1,45 +1,58 @@
-# UI for Laravel Folio
+# Vellum - Simple Blogging for Laravel (Powered by Folio)
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/ejntaylor/vellum.svg?style=flat-square)](https://packagist.org/packages/ejntaylor/vellum)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ejntaylor/vellum/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ejntaylor/vellum/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ejntaylor/vellum/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ejntaylor/vellum/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/ejntaylor/vellum.svg?style=flat-square)](https://packagist.org/packages/ejntaylor/vellum)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+This is a package providing a Simple UI for [Laravel Folio](http://github.com/laravel/folio) that provides a simple UI for managing your blog content. View all your posts, create new ones, edit existing ones, and delete them.
 
-## Support us
+## Installation
 
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/vellum.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/vellum)
+You can install the package via composer:
 
-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).
+```bash
+composer require ejntaylor/vellum
+```
 
-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).
+## Folio Installation
 
-## Installation
+Folio is a required package so will be installed automatically. You will need to follow the instructions to install Folio.
 
-You can install the package via composer:
+Specifially, you will need to run the following commands:
 
 ```bash
-composer require ejntaylor/vellum
+php artisan folio:install
+```
+
+Until Folio is out of beta you will need to set the following in your composer.json file:
+
+```bash
+    "minimum-stability": "beta"
 ```
 
-You can publish and run the migrations with:
+
+
+You will then need to publish the assets so we can style Vellum:
 
 ```bash
-php artisan vendor:publish --tag="vellum-migrations"
-php artisan migrate
+php artisan vendor:publish --tag="vellum-assets"
 ```
 
 You can publish the config file with:
 
 ```bash
 php artisan vendor:publish --tag="vellum-config"
+
 ```
 
 This is the contents of the published config file:
 
 ```php
 return [
+    'middleware' => [
+        'auth' => \Ejntaylor\Vellum\Http\Middleware\AuthMiddleware::class,
+    ],
 ];
 ```
 
@@ -49,35 +62,38 @@ Optionally, you can publish the views using
 php artisan vendor:publish --tag="vellum-views"
 ```
 
-## Usage
-
-```php
-$vellum = new Ejntaylor\Vellum();
-echo $vellum->echoPhrase('Hello, Ejntaylor!');
-```
+## Auth
 
-## Testing
+You might already have Authentication setup. If you are starting with a fresh install you might want to use the Laravel Breeze package to get up and running quickly.
 
 ```bash
-composer test
+composer require laravel/breeze --dev
+php artisan breeze:install
 ```
 
+## Usage
+
+Install with the above instructions and make sure to publish the assets.
+
+Make sure you have auth setup. 
+
+Then head to https://yourapp.com/vellum to view the UI. Login and go - that's it!
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
 ## Contributing
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+I welcome all contributions - please submit a Pull Request and I'll review it as soon as I can.
 
 ## Security Vulnerabilities
 
-Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
+Please get in touch to report security vulnerabilities.
 
 ## Credits
 
 - [Elliot Taylor](https://github.com/ejntaylor)
-- [All Contributors](../../contributors)
 
 ## License
 

composer.json

@@ -1,9 +1,16 @@
 {
     "name": "ejntaylor/vellum",
-    "description": "UI for Laravel Folio",
+    "description": "Vellum - Simple Blogging for Laravel (Powered by Folio)",
     "keywords": [
         "ejntaylor",
         "laravel",
+        "folio",
+        "blogging",
+        "blog",
+        "publishing",
+        "publish",
+        "posts",
+        "articles",
         "vellum"
     ],
     "homepage": "https://github.com/ejntaylor/vellum",
@@ -18,7 +25,8 @@
     "require": {
         "php": "^8.1",
         "spatie/laravel-package-tools": "^1.14.0",
-        "illuminate/contracts": "^10.0"
+        "illuminate/contracts": "^10.0",
+        "laravel/folio": "^1.0@beta"
     },
     "require-dev": {
         "laravel/pint": "^1.0",
@@ -69,4 +77,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

config/vellum.php

@@ -3,6 +3,6 @@
 // config for Ejntaylor/Vellum
 return [
     'middleware' => [
-        'auth' => \Ejntaylor\Vellum\Http\Middleware\AuthMiddleware::class,
+        'auth' => 'auth',
     ],
 ];