Merge branch 'develop' into main

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Release notes
+
+## [Unreleased](https://github.com/adrianmejias/veil/compare/v1.0...1.x)
+
+## [v1.0.0 (2021-08-17)](https://github.com/adrianmejias/veil/compare/v1.0...v1.0.0)
+
+- Update README.md
+- Added CHANGELOG.md file
+- Added SECURITY.md file
+- Added minor for semantic versioning
+
+## v1.0 - 2021-07-15
+
+- initial release

README.md

@@ -6,10 +6,13 @@ Autoloader for custom class instances.
 
 ## Installation
 
+This version supports PHP 8.0. You can install the package via composer:
+
 `composer require adrianmejias/veil`
 
-## Basic Usage
+## Usage
 
+### Example
 ```php
 <?php
 
@@ -19,21 +22,30 @@ use AdrianMejias\Veil\Veil;
 
 $veil = new Veil();
 $veil->register();
+
+// An example when setting up a flolder and composer psr-4
+// autoload is setup as: "Veils\\": "src/Veils/"
 $veil->add([
-    'Foo' => Veils\FooVeil::class,
+    'Foo' => Veils\FooVeil::class, // The alias name and abstract class to alias against.
 ]);
 // $veil->add('Foo', Veils\FooVeil::class);
-// composer autoload psr-4 -> "Veils\\": "src/Veils/",
 
+// An example if the bar method in the Foo class returned 'world'
 echo 'Hello, ' . \Foo::bar() . '!';
-// Foo->bar() -> return 'world'
+// use Foo;
+// ...
+// echo 'Hello, ' . Foo::bar() . '!';
 ```
 
 Expected Output:
 ```html
 Hello, world!
 ```
 
+## Testing
+
+`composer test`
+
 ## Todo
 
 - [x] Add to packagist repo
@@ -46,12 +58,16 @@ Hello, world!
 
 ## Contributing
 
-Thank you for considering contributing to Testbench! You can read the contribution guide [here](.github/CONTRIBUTING.md).
+Thank you for considering contributing to Veil! You can read the contribution guide [here](.github/CONTRIBUTING.md).
 
 ## Code of Conduct
 
 In order to ensure that the community is welcoming to all, please review and abide by the [Code of Conduct](.github/CODE_OF_CONDUCT.md).
 
+## Security Vulnerabilities
+
+Please see the [security file](SECURITY.md) for more information.
+
 ## License
 
-Testbench is open-sourced software licensed under the [MIT license](LICENSE.md).
+The MIT License (MIT). Please see the [license file](LICENSE.md) for more information.

SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :white_check_mark: |
+| < 1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within Laravel, please send an e-mail to Adrian Mejias via [email protected]. All security vulnerabilities will be promptly addressed.