diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e3f371 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# Very short description of the package + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/devdojo/auth.svg?style=flat-square)](https://packagist.org/packages/devdojo/auth) +[![Total Downloads](https://img.shields.io/packagist/dt/devdojo/auth.svg?style=flat-square)](https://packagist.org/packages/devdojo/auth) +![GitHub Actions](https://github.com/devdojo/auth/actions/workflows/main.yml/badge.svg) + +This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors. + +## Installation + +You can install the package via composer: + +```bash +composer require devdojo/auth +``` + +## Usage + +```php +// Usage description here +``` + +### Testing + +```bash +composer test +``` + +### Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +### Security + +If you discover any security related issues, please email tony@devdojo.com instead of using the issue tracker. + +## Credits + +- [Tony Lea](https://github.com/devdojo) +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. + +## Laravel Package Boilerplate + +This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).