init

README.md

@@ -0,0 +1,76 @@
+# :package_description
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
+[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/run-tests?label=tests)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
+
+This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require :vendor_slug/:package_slug
+```
+
+You can publish and run the migrations with:
+
+```bash
+php artisan vendor:publish --tag=":package_slug-migrations"
+php artisan migrate
+```
+
+You can publish the config file with:
+
+```bash
+php artisan vendor:publish --tag=":package_slug-config"
+```
+
+Optionally, you can publish the views using
+
+```bash
+php artisan vendor:publish --tag=":package_slug-views"
+```
+
+This is the contents of the published config file:
+
+```php
+return [
+];
+```
+
+## Usage
+
+```php
+$skeleton = new VendorName\Skeleton();
+echo $skeleton->echoPhrase('Hello, VendorName!');
+```
+
+## Testing
+
+```bash
+composer test
+```
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
+
+## Security Vulnerabilities
+
+Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
+
+## Credits
+
+- [:author_name](https://github.com/:author_username)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.