add annotations

Author: kareem-weaver

doc/README.md

@@ -8,29 +8,32 @@ binding according to the `free_interface` abstract interface defined in
 `sp_resource_m`.  The user-defined `free` subroutine must free the associated
 resource, which usually means deallocating the associated memory.
 
-
-
-<h2 align="center">smart-pointers-class-diagram</h2>
-
-  ```mermaid
+```mermaid
+---
+title: Smart Pointers Class Diagram 
+---
 classDiagram
-sp_resource_t --* sp_reference_counter_t
-sp_resource_t : free()
 
-sp_smart_pointer_t --|> sp_resource_t
-
-class sp_smart_pointer_t {
--counter_ : counter_t
-release_handle()
-start_counter()
+class sp_resource_t {
+    free()
 }
-
-sp_reference_counter_t --* sp_smart_pointer_t 
+    <<Abstract>> sp_resource_t
+    sp_resource_t--*sp_reference_counter_t
 
 class sp_reference_counter_t {
--count_ : integer, pointer
--object_ : sp_resource_t
-grab()
-release()   
+    -count_: integer, pointer
+    -object_: sp_resource_t
+    grab()
+    release()   
 }
+sp_reference_counter_t--*sp_smart_pointer_t
+
+class sp_smart_pointer_t {
+    -counter_:counter_t
+    release_handle()
+    start_counter()
+}
+<<Abstract>> sp_smart_pointer_t
+    sp_smart_pointer_t--|>sp_resource_t
+
 ```