Skip to content

Commit

Permalink
Add note about supported character encodings
Browse files Browse the repository at this point in the history
  • Loading branch information
kaiburjack authored Aug 15, 2022
1 parent f1bed47 commit 071ea3c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ In addition to handling namespaces, gosaxml can also canonicalize and minify XML
and does not repeat the prefix-less namespace declaration
on all encoded XML elements, like `encoding/xml` does.

Due to the way it is implemented right now, the byte slices it reads from a provided `io.Reader` can only be ASCII or UTF-8 encoded. UTF-16 and UTF-32 character encodings or other encodings not identical with the ASCII character set or not using multi-byte encodings where the high bit is always set, are _not_ supported.

# Get it

```shell
Expand Down Expand Up @@ -55,4 +57,4 @@ func TestDecodeAndEncode(t *testing.T) {
`<a xmlns="http://mynamespace.org"><b>Hi!</b><c/></a>`,
w.String())
}
```
```

0 comments on commit 071ea3c

Please sign in to comment.