all the things

mail/mu/pkg/README

@@ -0,0 +1,28 @@
+Breaking Changes from 1.2. to 1.4.
+══════════════════════════════════
+
+A description of all changes and features can be found the release
+notes (NEWS.org). Breaking changes below:
+
+mu changes:
+-----------
+* Base path has changed from ~/.mu to ~/.cache/mu. You may want to
+  delete the old cache location.
+* A new command `mu init` needs to be run once to save the maildir
+  location and email adresses in the database.
+
+  mu init --maildir=~/Maildir --my-address=jim@example.com \
+                --my-address=bob@example.com
+
+mu4e changes:
+-------------
+* Variables `mu4e-maildir` and `mu4e-user-mail-address-list`
+  are obsolete. The information is taken from the Xapian database now.
+  Run `mu init` with the appropiate parameters to create these
+  entries.
+* Contact sorting is done by `mu` now. As a side effect the following
+  variables have been obsoleted:
+    - mu4e-contacts-rewrite-function
+    - mu4e-compose-complete-ignore-address-regexp
+  You can use `mu4e-contact-process-function` instead.
+