Skip to content

Commit d4cad3b

Browse files
committed
Update readme before publishing v3.0.0
Also explaining the breaking change between v2.5.0 -> v3.0.0.
1 parent ede74b6 commit d4cad3b

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

Readme.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,15 @@ Contributions are more than welcome! Create an issue describing what you want to
133133

134134
## Changelog
135135

136+
### v3.0.0
137+
- Change xml2json to xml2js by @OverloadUT
138+
139+
#### BREAKING CHANGE
140+
141+
Some of URIs on the Plex Server responds with XML instead of JSON. Previous versions of plex-api used xml2json to translate between XML to JSON. We have now replaced xml2json with xml2js which might result in a different JSON format when requesting URIs responding with XML.
142+
143+
Please see the documentation of (xml2json)[https://github.com/buglabs/node-xml2json] and (xml2js)[https://github.com/Leonidas-from-XIV/node-xml2js] for more details about their differences.
144+
136145
### v2.5.0
137146
- Updated the readme to explain each of the X-Plex headers by @OverloadUT
138147
- The X-Plex headers are now sent on every request by @OverloadUT

0 commit comments

Comments
 (0)