diff --git a/README_original.md b/README_original.md new file mode 100644 index 0000000..f2a31d9 --- /dev/null +++ b/README_original.md @@ -0,0 +1,78 @@ +# This is my package filament-oauth2 + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/alexandergabriel/filament-oauth2.svg?style=flat-square)](https://packagist.org/packages/alexandergabriel/filament-oauth2) +[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/alexandergabriel/filament-oauth2/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/alexandergabriel/filament-oauth2/actions?query=workflow%3Arun-tests+branch%3Amain) +[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/alexandergabriel/filament-oauth2/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/alexandergabriel/filament-oauth2/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain) +[![Total Downloads](https://img.shields.io/packagist/dt/alexandergabriel/filament-oauth2.svg?style=flat-square)](https://packagist.org/packages/alexandergabriel/filament-oauth2) + + + +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 alexandergabriel/filament-oauth2 +``` + +You can publish and run the migrations with: + +```bash +php artisan vendor:publish --tag="filament-oauth2-migrations" +php artisan migrate +``` + +You can publish the config file with: + +```bash +php artisan vendor:publish --tag="filament-oauth2-config" +``` + +Optionally, you can publish the views using + +```bash +php artisan vendor:publish --tag="filament-oauth2-views" +``` + +This is the contents of the published config file: + +```php +return [ +]; +``` + +## Usage + +```php +$filamentOauth2 = new AlexanderGabriel\FilamentOauth2(); +echo $filamentOauth2->echoPhrase('Hello, AlexanderGabriel!'); +``` + +## 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 + +- [Alexander Gabriel](https://github.com/AlexanderGabriel) +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information.