diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb4e755 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Statamic MagicLink - Login without a password + +A Statamic V3 addon to provide the option to login into the Control Panel without using a password. Instead use a magic link +which is sent by email. + +# Installation + +Run the following the pull in the package with composer + +## Step 1 + +````bash +composer require codedge/statamic-magiclink +```` + +## Step 2 + +Login into your Statamic CP, see "MagicLink" in the side menu and enable it. + +## Step 3 + +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. + +# License + +Before going into production with *Statamic MagicLink*, you need to buy a licence at the [Statamic Marketplace](https://statamic.com/addons?statamic=3). +*Statamic MagicLink* is not free software!