docs

sigmaSd · Apr 6, 2024 · 2d04ce8 · 2d04ce8
1 parent 9154c9f
commit 2d04ce8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ function writeBufferAsPPM(
 }
 ```
 
-This library exprots 3 levels of abstractions:
+This library exports 3 levels of abstractions:
 
 - ffi: raw deno bindings to openpnp
 - openpnp: thin javascript wrapper over the raw bidings

diff --git a/src/camera.ts b/src/camera.ts
@@ -48,6 +48,14 @@
  * }
  * ```
  *
+ * This library exports 3 levels of abstractions:
+ *
+ * - ffi: raw deno bindings to openpnp
+ * - openpnp: thin javascript wrapper over the raw bidings
+ * - default export: high level javascript api
+ *
+ * The default export is the recommended to use.
+ *
  * @module
  */