Feature/star 40 (#46)

* Remove temp register emial for login event

* Add readme to templateemail package

* Change lithium

* Added correct bugs, returned from cholek

Co-authored-by: Hubert Krzysztofiak <[email protected]>

README.md

@@ -1,6 +1,6 @@
 # Templates-Email
 
-Package for email notifiations with editable templates (for important user-related events)
+Package for email notifications with editable templates (for important user-related events)
 
 [![codecov](https://codecov.io/gh/EscolaLMS/Templates-Email/branch/main/graph/badge.svg?token=O91FHNKI6R)](https://codecov.io/gh/EscolaLMS/Templates-Email)
 [![Tests PHPUnit in environments](https://github.com/EscolaLMS/Templates-Email/actions/workflows/test.yml/badge.svg)](https://github.com/EscolaLMS/Templates-Email/actions/workflows/test.yml)
@@ -9,3 +9,39 @@ Package for email notifiations with editable templates (for important user-relat
 [![downloads](https://img.shields.io/packagist/dt/escolalms/templates-email)](https://packagist.org/packages/escolalms/templates-email)
 [![downloads](https://img.shields.io/packagist/v/escolalms/templates-email)](https://packagist.org/packages/escolalms/templates-email)
 [![downloads](https://img.shields.io/packagist/l/escolalms/templates-email)](https://packagist.org/packages/escolalms/templates-email)
+
+## What does it do
+
+This package allows you to create email notifications for events emitted in Laravel app.
+
+Each notification is created as a class describing available variables that can be used in Template (which will be created in database and editable through admin panel). This class must be registered using Template facade from Template package, where you specify which Event it is associated with and which Channel it is sent through (e.g. Email channel when defined in this package).
+
+## Installing
+
+- `composer require escolalms/templates-email`
+## Template used
+
+1. Create event which triggers sending email using specified template. This event must implement method getUser() returning User model from LMS Core package.
+2. Create Class defining template variables, which you will use in email notification,
+3. Associate your class describing template variables with event and channel through which notifications should be sent. Use `EscolaLms\Templates\Facades\Template::register(Event class, EscolaLms\TemplatesEmail\Core\EmailChannel::class, Variable class);`
+4. Register template in db for admin panel or used `/api/admin/templates`, better described in [Template package](https://github.com/EscolaLMS/Templates)
+
+## Tests
+
+Run `./vendor/bin/phpunit --filter 'EscolaLms\\TemplatesEmail\\Tests'` to run tests. See [tests](tests) folder as it contains a basic implementation of Variable (or Template description) class with minimal customisation - a quite good starting point for creating your own.
+
+Test details [![codecov](https://codecov.io/gh/EscolaLMS/Templates-Email/branch/main/graph/badge.svg?token=O91FHNKI6R)](https://codecov.io/gh/EscolaLMS/Templates-Email) [![Tests PHPUnit in environments](https://github.com/EscolaLMS/Templates-Email/actions/workflows/test.yml/badge.svg)](https://github.com/EscolaLMS/Templates-Email/actions/workflows/test.yml)
+
+### Admin panel
+
+**Left menu**
+
+![Menu](docs/templates-email/menu.png "Menu")
+
+**List of templates**
+
+![List of templates](docs/templates-email/list.png "List of templates")
+
+**Creating/editing template**
+
+![Creating/editing template](docs/templates-email/edit.png "Creating or editing template")