Move a few things about to make compiling with other projects possible.

[apps/low-level-can-service.git] / README.mkd

diff --git a/README.mkd b/README.mkd
index 6c3efa9..9803048 100644 (file)
--- a/README.mkd
+++ b/README.mkd
@@ -43,15 +43,15 @@ system:
         ...
     }
 
-With your shims in place, create an IsoTpShim object to pass them around:
+With your shims in place, create an IsoTpShims object to pass them around:
 
-    IsoTpShim shims = isotp_init_shims(debug, send_can, set_timer);
+    IsoTpShims shims = isotp_init_shims(debug, send_can, set_timer);
 
 ### API
 
 With your shims in hand, send an ISO-TP message:
 
-    // Optiona: This is your callback that will be called when the message is
+    // Optional: This is your callback that will be called when the message is
     // completely sent. If it was single frame (the only type supported right
     // now), this will be called immediately.
     void message_sent(const IsoTpMessage* message, const bool success) {
@@ -66,8 +66,8 @@ With your shims in hand, send an ISO-TP message:
             // send CAN messages
             return;
         } else {
-            // If the message fit in a single frame, it's already been sent and
-            you're done
+            // If the message fit in a single frame, it's already been sent
+            // and you're done
         }
     } else {
         while(true) {
@@ -132,7 +132,8 @@ You can also see the test coverage if you have `lcov` installed and the
 
 ## Authors
 
-Chris Peplin cpeplin@ford.com
+* Chris Peplin cpeplin@ford.com
+* David Boll dboll2@ford.com (the inspiration for the library's API is from David)
 
 ## License