Add information about python-can interface and docs in the readme

supermete · Apr 26, 2024 · a3ab54b · a3ab54b
1 parent e2a605c
commit a3ab54b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ caro.shutdown()  # free the bus
 
 ## Features
 
-- This library uses the python-can library to communicate with the device.
+- This library uses the python-can library to communicate with the device. Please refer to its documentation to know about all the CAN interfaces that can be used with this library (https://python-can.readthedocs.io/en/stable/)
 - The device has 4 digital outputs and 4 digital inputs. Hence the signals
 can be read/written by using the attributes of the CaroA04 class:
   - do1, do2, do3, do4 : digital output 1 to digital output 4

diff --git a/README.rst b/README.rst
@@ -63,7 +63,7 @@ Usage
 Features
 --------
 
-* This library uses the python-can library to communicate with the device.
+* This library uses the python-can library to communicate with the device. Please refer to its documentation to know about all the CAN interfaces that can be used with this library (https://python-can.readthedocs.io/en/stable/)
 * The device has 4 digital outputs and 4 digital inputs. Hence the signals can be read/written by using the attributes of the CaroA04 class:
     * do1, do2, do3, do4 : digital output 1 to digital output 4
     * di1, di2, di3, di4 : digital input 1 to digital input 4