summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorstanleyhuangyc <stanleyhuangyc@gmail.com>2013-03-25 01:06:38 +0800
committerstanleyhuangyc <stanleyhuangyc@gmail.com>2013-03-25 01:06:38 +0800
commitdbfcc3666e91867ecc2a23c4a94abb972c71f654 (patch)
tree85b32368f1537f145fd0f4b4f38cc51f6e4920fa /README.md
parent12661032b0c11a09b939b1424c8dfc709f2fb7bf (diff)
download2021-arduino-obd-dbfcc3666e91867ecc2a23c4a94abb972c71f654.tar.gz
2021-arduino-obd-dbfcc3666e91867ecc2a23c4a94abb972c71f654.tar.bz2
2021-arduino-obd-dbfcc3666e91867ecc2a23c4a94abb972c71f654.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index a9a0490..8597952 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,24 @@
Arduino OBD-II UART Adapter Library & Examples
==============================================
-(C)2012-2013 Stanley Huang <stanleyhuangyc@gmail.com>
+(C)2012-2013 Stanley Huang
+
+The Arduino OBD-II UART Adapter is a product works as an OBD-II to serial UART data bridge with open-source Arduino library provided. Besides providing OBD-II data access, it also provides power supply (converted and regulated from OBD-II port) for Arduino and its attached devices. The adapter can also be used in other embedded systems with serial UART interface.
+
+Product page: http://www.arduinodev.com/hardware/obd-kit/
+
+<strong>Directory Descriptions</strong>
libraries/OBD - Arduino library for OBD-II adapter
+
samples/rpm_led - a simplest example sketch implementing a RPM indicator with the pin 13 LED on Arduino board
+
samples/dashboard_1602 - an example sketch showing a set of vehicle data with a LCD1602 shield
+
samples/dashboard_4884 - a sketch providing extensive display of vehicle data with a LCD4884 shield
+
samples/dashboard_oled - a sketch providing extensive display of vehicle data with a OLED module
+
samples/obdtest - a testing sketch for OBD-II adapter
+
obdlogger - a complete OBD-II and GPS data logger (http://obd.arduinodev.com)