Prepare changelog for 1.5rc1
[libftdi] / README
diff --git a/README b/README
index 072b671..27fbed0 100644 (file)
--- a/README
+++ b/README
@@ -20,17 +20,32 @@ that made libftdi possible what it is today.
 
 Changes
 -------
-* New ftdi_usb_open_bus_addr() open function
-* Use BM/R series baud rate computation for FT230X
-* ftdi_get_error_string() now returns const char*
-* C++ API: Ability to open devices with empty descriptor strings
-* C++ API: Fix enumerations for buffer purge and modem controls
-* small build fixes and improvements in the python examples
+* Implement tc[io]flush methods & deprecate broken purge_buffers methods
+
+  Please check your code for ftdi_usb_purge_rx_buffer(),
+  ftdi_usb_purge_tx_buffer() and ftdi_usb_purge_buffers()
+  and migrate to the new ftdi_tc[io]flush() methods.
+
+  Old code will continue to function, but you'll get
+  a deprecation warning during compilation.
+
+* Add program to test buffer flush (purge) functionality
+* Add kernel driver auto attach/detach.
+  See new AUTO_DETACH_REATACH_SIO_MODULE option
+* Add ftdi_setflowctrl_xonxoff()
 * ftdi_eeprom / eeprom handling:
-  * New API function: ftdi_eeprom_get_strings()
-  * Fix USE_SERIAL handling for 230X type chips
-  * Make ftdi_read_eeprom_location() endianness independent
-  * Fix flashing of FT245R
+  * Unify handling of all boolean eeprom flags
+  * Add device release number support
+  * Add channel_a_driver support for type xxR chips
+  * Add support for group0 drive levels on x232H chips
+  * Fix handling of high_current_drive parameter
+  * Fix inverted handling of VCP driver field for TYPE_R chips
+  * New --verbose option for eeprom decode operation
+* Add example code for async mode
+* Add SPDX license identifiers to the core library & ftdi_eeprom
+* Various python SWIG wrapper improvements
+* Various cmake file improvements
+* Fix small bugs in error code paths
 
 You'll find the newest version of libftdi at:
 https://www.intra2net.com/en/developer/libftdi