Fix building unit tests without FTDIPP
[libftdi] / README
diff --git a/README b/README
index f41e2a2..c64f884 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,12 @@
 --------------------------------------------------------------------
-libftdi version 1.0rc1
+libftdi version 1.5
 --------------------------------------------------------------------
 
 libftdi - A library (using libusb) to talk to FTDI's UART/FIFO chips
 including the popular bitbang mode.
 
 The following chips are supported:
+* FT230X
 - FT4232H / FT2232H
 - FT232R  / FT245R
 - FT2232L / FT2232D / FT2232C
@@ -19,9 +20,35 @@ that made libftdi possible what it is today.
 
 Changes
 -------
+* 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:
+  * 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:
-http://www.intra2net.com/en/developer/libftdi
+https://www.intra2net.com/en/developer/libftdi
 
 
 Quick start
@@ -36,5 +63,5 @@ make install
 More verbose build instructions are in "README.build"
 
 --------------------------------------------------------------------
-www.intra2net.com                             2003-2013 Intra2net AG
+www.intra2net.com                             2003-2020 Intra2net AG
 --------------------------------------------------------------------