Add library documentation site to the README.md

* fix small mo-doc formatting issue
canscale · Jan 26, 2023 · cc6367a · cc6367a
1 parent 1271208
commit cc6367a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,11 @@
 # StableHeapBTreeMap
 
-Main memory/heap-based BTree data structures written in Motoko
-
+A functional, heap-based BTree data structure written in Motoko
 
 
 ## API Documentation
 
-TODO
+API documentation for this library can be found at https://canscale.github.io/StableHeapBTreeMap/BTree.html
 
 ## License
 

diff --git a/src/BTree.mo b/src/BTree.mo
@@ -130,8 +130,8 @@ module {
 
 
   /// The direction of iteration
-  /// #fwd -> forward (ascending)
-  /// #bwd -> backwards (descending)
+  /// \#fwd -> forward (ascending)
+  /// \#bwd -> backwards (descending)
   public type Direction = { #fwd; #bwd };
 
   /// The object returned from a scan contains: