From 3c843f2f9e69e368eacb6be26176291cc841ff5d Mon Sep 17 00:00:00 2001 From: "J. King" Date: Fri, 10 Aug 2018 13:32:44 -0400 Subject: [PATCH] Basic readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..135a0ec --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Dependency-free internationalization tools for PHP + +While PHP's [internationalization extension][PHP_INTL] offers excellent and extensive functionality for dealing with human languages, character encodings, and various related things, it is not always available. Moreover, its character decoder does not yield the same results as [WHATWG's Encoding standard][ENCODING], making it unsuitable for implementing parsers for URLs or HTML. The more widely used [multi-byte string extension][PHP_MBSTRING] not only suffers the same problems, but is also very slow. + +Included here is a WHATWG-compatible UTF-8 string decoder which is reasonably performant while requiring no external dependencies or PHP extensions. In time it will be extended to cover the entire suite of WHATWG character encodings, and may also provide other character-centric internationalization functionality. + +[PHP_INTL]: https://php.net/manual/en/book.intl.php +[PHP_MBSTRING]: https://php.net/manual/en/book.mbstring.php +[ENCODING]: https://encoding.spec.whatwg.org/