From 3f86a3e491a23157c26596ead2eb03ead4f04d33 Mon Sep 17 00:00:00 2001 From: Sam Verschueren Date: Sat, 27 May 2017 13:26:05 +0200 Subject: [PATCH] add why section --- readme.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/readme.md b/readme.md index 170d71a..795c87f 100644 --- a/readme.md +++ b/readme.md @@ -5,6 +5,14 @@ > A better [decodeURIComponent](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent) +## Why? + +- Decodes `+` to a space. +- Converts the [BOM](https://en.wikipedia.org/wiki/Byte_order_mark) to a [replacement character](https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character) `�`. +- Does not throw with invalid encoded input. +- Decodes as much of the string as possible. + + ## Install ```