diff --git a/README.md b/README.md index f87f5c1..48c71aa 100644 --- a/README.md +++ b/README.md @@ -1 +1,63 @@ -# TODO \ No newline at end of file +## Installation + +Install via composer + +``` bash +$ composer require lifeonscreen/nova-google2fa +``` + +Run migrations + +``` bash +$ php artisan migrate +``` + +Publish config + +``` bash +$ php artisan vendor:publish --provider="Lifeonscreen\Google2fa\ToolServiceProvider" +``` + +Add relation to User model +```php +use Lifeonscreen\Google2fa\Models\User2fa; + +... + +/** + * @return HasOne + */ +public function user2fa(): HasOne +{ + return $this->hasOne(User2fa::class); +} +``` + +Add middleware to `nova.config`. +```php +[ + ... + 'middleware' => [ + ... + \Lifeonscreen\Google2fa\Http\Middleware\Google2fa::class, + ... + ], +] +``` + +## Security + +If you discover any security-related issues, please email the author instead of using the issue tracker. +## Credits +- [Jani Cerar](https://github.com/janicerar) + +## License + +MIT license. Please see the [license file](docs/license.md) for more information. + +[ico-version]: https://img.shields.io/packagist/v/lifeonscreen/nova-google2fa.svg?style=flat-square +[ico-downloads]: https://img.shields.io/packagist/dt/lifeonscreen/nova-google2fa.svg?style=flat-square + +[link-packagist]: https://packagist.org/packages/lifeonscreen/nova-google2fa +[link-downloads]: https://packagist.org/packages/lifeonscreen/nova-google2fa +[link-author]: https://github.com/LifeOnScreen \ No newline at end of file diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..650f0f0 --- /dev/null +++ b/docs/license.md @@ -0,0 +1,23 @@ +# The license + +Copyright 2018 LifeOnScreen Global Limited and other contributors, +https://lifeonscreen.com + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file