Commit 60ac1418 authored by totten's avatar totten
Browse files

README.md

parent 85779283
......@@ -5,10 +5,11 @@
![Screenshot](/images/screenshot.png)
This extension synchronizes Mosaico templates to CiviCRM "Message Templates", which allows you to use the
templates for scheduled reminders, one-off mailings, etc.
This extension enables you to use [CiviCRM-Mosaico](https://github.com/veda-consulting/uk.co.vedaconsulting.mosaico/)
templates with scheduled reminders, personal messages, etc. It does this by automatically copying each
template from Mosaico to a CiviCRM "Message Template".
When you install the extension, existing `MosaicoTemplate`s will be automatically copied to `MessageTemplate`s.
When you install the extension, all existing `MosaicoTemplate`s will be automatically copied to `MessageTemplate`s.
When you create or update a `MosaicoTemplate`, the corresponding `MessageTemplate` will be updated.
......@@ -20,12 +21,10 @@ The extension is licensed under [AGPL-3.0](LICENSE.txt).
* CiviCRM 4.7.28+ (recommended)
* CiviCRM-Mosaico v2.0+
## Installation (Web UI)
## Installation
This extension has not yet been published for installation via the web UI.
## Installation (CLI, Zip)
Sysadmins and developers may download the `.zip` file for this extension and
install it with the command-line tool [cv](https://github.com/civicrm/cv).
......@@ -34,10 +33,9 @@ cd <extension-dir>
cv dl org.civicrm.mosaicomsgtpl@https://github.com/civicrm/org.civicrm.mosaicomsgtpl/archive/master.zip
```
## Installation (CLI, Git)
Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
install it with the command-line tool [cv](https://github.com/civicrm/cv).
Alternatively, sysadmins and developers may clone the
[Git](https://en.wikipedia.org/wiki/Git) repo for this extension and install
it with the command-line tool [cv](https://github.com/civicrm/cv).
```bash
git clone https://github.com/civicrm/org.civicrm.mosaicomsgtpl.git
......@@ -56,6 +54,5 @@ System administrators and developers may wish to use the synchronization API:
## Known Issues
* Synchronization is one-way. To make changes, you should only use the Mosaico template editor.
* When you load a Mosaico template into CKEditor, TinyMCE, or any other editor, you should tred carefully
and only make small changes to the text. Attempting to change meaningfully the layout may prove
quite difficult.
* When you load a Mosaico template into a richtext editor (such as CKEditor or TinyMCE), you should tred
carefully: only make small changes to the text. Changing the layout in a substantive way would be difficult.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment