ready for public

README.md

@@ -1,10 +1,23 @@
-# de.systopia.householdmerge
+# CiviCRM Household Tools
 
-CiviCRM Extension to merge contacts into households. It simply provides an action for the contact search results.
+CiviCRM Extension to support you with creating and maintaining households. It is currently under development, so feel free to contact us for the bits that are still missing - or simply contribute the implementations.
 
+The extension allows you to choose on of three household modes:
+
+1. **merged**: all contacts get merged into the household contact, the original contacts will be deleted
+2. **linked**: all member contacts are connected to the household via 'member of' relationship
+3. **hierarchy**: member contacts are connected to the household via 'member of' or 'head of' relationship. There is only one head.
 
----
+The extension so far gives you three different tools:
 
-Funded by [Forum Ziviler Friedensdienst e.V.](http://www.forumzfd.de/)
+1. **create from search result**: Select the contacts in a search result and choose the action "join to household". Currently only for mode 'merged'.
+2. **find households**: Scan your database for potential new households (based on last name and address). Currently only for mode 'linked' and 'hierarchy'.
+2. **check households**: Cron job to check your existing households for integrety and consistency. Currently only for mode 'linked' and 'hierarchy'.
 
-For ideas and questions feel free to contact Bendikt Kaleß, kaless@forumZFD.de. We are very interested in participating in the continuous improvement of CiviCRM.
+
+
+First stage (merged households on search results) funded by [Forum Ziviler Friedensdienst e.V.](http://www.forumzfd.de/), contact person Bendikt Kaleß, kaless (at) forumZFD.de.
+
+Second stage (linked and hierarchy tools) funded by [muslime**helfen** e.V.](http://www.muslimehelfen.org/), contact person Fouad Rebbah, Fouad.Rebbah (at) muslimehelfen.org
+
+For ideas and questions feel free to contact them.

info.xml

@@ -14,9 +14,9 @@
     <url desc="Support">https://github.com/systopia/de.systopia.householdmerge</url>
     <url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
   </urls>
-  <releaseDate>2016-04-01</releaseDate>
-  <version>0.4dev-401</version>
-  <develStage>development</develStage>
+  <releaseDate>2016-05-25</releaseDate>
+  <version>1.0.alpha1</version>
+  <develStage>testing</develStage>
   <compatibility>
     <ver>4.4</ver>
     <ver>4.6</ver>