From b11d3c65effa67cdf40a7f5d969ccf0e05642634 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Holger=20Lo=CC=88sken?= Date: Thu, 17 Sep 2020 21:52:30 +0200 Subject: [PATCH] Improve documentation --- DOCUMENTATION.md | 16 ++++++++++++++++ README.md | 8 ++++++-- 2 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 DOCUMENTATION.md diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md new file mode 100644 index 0000000..248291c --- /dev/null +++ b/DOCUMENTATION.md @@ -0,0 +1,16 @@ +## Permissions + +The access to settings of MagicLink can be restricted to certain users. When navigation to _Permissions_ inside the +Control Panel just create a new role and assign the _MagicLink > View settings_ permission. + + +## Customization + +Views, translations and config settings can be tweaked by you. You just need to run + +``` +php artisan vendor:publish --tag=config --provider="Codedge\MagicLink\ServiceProvider" +``` + +to publish all assets things you like to modify. + diff --git a/README.md b/README.md index eb4e755..7e6a7f5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ which is sent by email. # Installation -Run the following the pull in the package with composer +Run the following the pull in the package with composer: ## Step 1 @@ -21,7 +21,11 @@ Login into your Statamic CP, see "MagicLink" in the side menu and enable it. On the CP login page you can now see a link "Send Magic Link". -:warning: Make sure your email settings are configured and email sending works. +:information_source: Make sure your email settings are configured and email sending works. + +# Wishes & ideas + +Just open an [issue at Github](https://github.com/codedge/statamic-magiclink/issues) and I'll see what I can do :) # License