change: Mark that this package is now abandoned

Author: acoulton

README.md

@@ -1,3 +1,18 @@
+This package is abandoned
+=========================
+
+This package is now abandoned and will not receive further updates. The underlying transliteration
+dataset it is based on has not been updated since 2016, and there are now better options available.
+Additionally, there are some complications around licensing (see #3) due to the mixed licenses of
+the original packages it was based on.
+
+Suggested alternatives include:
+
+* symfony/string for generating slugs
+* the native `Transliterator` class built into PHP's `ext-intl` for transliterating text.
+  Unlike this package, that can also respect locale-dependent transliterations.
+* The `//TRANSLIT` feature of PHP's native `iconv()` extension (available by default)
+
 Behat Transliterator
 ====================
 

composer.json

@@ -1,5 +1,6 @@
 {
   "name": "behat/transliterator",
+  "abandoned": true,
   "description": "String transliterator",
   "keywords": [
     "transliterator",