Update README.md to include generic interfaces

havelessbemore · May 13, 2024 · 2616a14 · 2616a14
1 parent 5229822
commit 2616a14
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,20 @@ yarn add semafy
 
 ## API
 
+### Generic
+
+- **BasicLockable**: A base interface that provides exclusive blocking for agents.
+
+- **Lockable**: Extends `BasicLockable` to include attempted locking.
+
+- **SharedLockable**: Provides shared blocking semantics for agents.
+
+- **SharedResource**: Represents a shared resource that is backed by a `SharedArrayBuffer`.
+
+- **SharedTimedLockable**: Extends `SharedLockable` to include timed blocking.
+
+- **TimedLockable**: Extends `Lockable` to include timed blocking.
+
 ### Mutex
 
 - **Mutex**: Provides essential mutex operations including `lock`, `unlock`, and `tryLock`.