From a4101f92e7278da7ce662d82cefc4a98e97765ea Mon Sep 17 00:00:00 2001 From: Johanna Wallther Date: Tue, 6 Mar 2018 21:09:36 +0000 Subject: [PATCH 1/2] Added titles from template and standard text. --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c16d80..53f1b0e 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,26 @@ This extension causes the recipients of a mailing to be recalculated just before You should probably not use this extension if you are relying on ACLs to limit the contacts to which CiviMail users can send. As it stands as the CiviMail author's ACLs are not taken into account when the recipients are recalculated (see [issue #1](https://github.com/3sd/civicrm-recalculate-recipients/issues/1) for more details). -## Contributions and improvements +## Requirements -Contributions to this repository are very welcome. You can also contact the maintainer (michaelmcandrew@thirdsectordesign.org) for further development work. +## Installation + +## Getting started + +## Documentation + +## Developers + +### Tests + +## Credits + +This extension has been developed by [Michael McAndrew](https://twitter.com/michaelmcandrew) from [Third Sector Design](https://thirdsectordesign.org/) who you can [contact](https://thirdsectordesign.org/contact) for help, support and further development. + +## Contributing + +Contributions to this repository are very welcome. Feel free to submit a pull request for minor improvements. For larger changes, please create an issue first. + +## License + +This extension is licensed under [AGPL-3.0](LICENSE.txt). From 6f214ddad8c258331a34654e0c4a3b710c838f8d Mon Sep 17 00:00:00 2001 From: Michael McAndrew Date: Mon, 12 Mar 2018 14:07:00 +0000 Subject: [PATCH 2/2] Updated readme --- README.md | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 53f1b0e..c41a75b 100644 --- a/README.md +++ b/README.md @@ -6,29 +6,46 @@ This means that any contacts that are added or removed to your groups in the tim This extension causes the recipients of a mailing to be recalculated just before the mail is sent out meaning you'll be sending based on the most up to data. -## Health warning: this extension is not ACL friendly +## Heath warning -You should probably not use this extension if you are relying on ACLs to limit the contacts to which CiviMail users can send. As it stands as the CiviMail author's ACLs are not taken into account when the recipients are recalculated (see [issue #1](https://github.com/3sd/civicrm-recalculate-recipients/issues/1) for more details). +**Recalculate recipients is currently in beta - use at your own risk.** + +The extension has been in production in at least one organisation for 3 months without issue. We we have not had any reports of it breaking anything from other organisations but even so, it has not been widely tested. + +*If this extension does work for you, please feedback by creating an issue in the github repostory with details of your use case. Once we have received a few positive reviews, we will move it out of beta.* + +### Not ACL friendly + +This extension is not ACL friendly. The CiviMail author's ACLs are not taken into account when the recipients are recalculated (see [issue #1](https://github.com/3sd/civicrm-recalculate-recipients/issues/1) for more details). + +Not not use it if you are relying on ACLs to limit the contacts to which CiviMail users can send ## Requirements +CiviCRM 4.7 + ## Installation -## Getting started +1. Read the [health warning](#health-warning) +2. Download a release from https://github.com/3sd/civicrm-recalculate-recipients/releases to your extensions directory +3. Browse to **Administer > System Settings > Extensions** +4. Find **Recalculate Recipients** and click **Install** -## Documentation +Note: for help on installing extensions, consult the [extensions chapter of the CiviCRM system administrator guide](https://docs.civicrm.org/sysadmin/en/latest/customize/extensions). -## Developers +## Getting started. -### Tests +Recalculate recipients is a simple extension with no configuration options. Once enabled it will start working automatically; recalculating recipients just before each mailing is sent. To stop recalculating recipients, simply disable the extension. ## Credits This extension has been developed by [Michael McAndrew](https://twitter.com/michaelmcandrew) from [Third Sector Design](https://thirdsectordesign.org/) who you can [contact](https://thirdsectordesign.org/contact) for help, support and further development. +Funding for this extension was generously provided by [eLife Sciences](https://elifesciences.org/), a unique, non-profit collaboration between the funders and practitioners of research to improve the way important results are presented and shared. + ## Contributing -Contributions to this repository are very welcome. Feel free to submit a pull request for minor improvements. For larger changes, please create an issue first. +Contributions to this repository are very welcome. For small changes, feel free to submit a pull request. For larger changes, we suggest you create an issue first so we can discuss the idea and approach. ## License