Added module docs

halvardssm · Apr 28, 2024 · 1c9cada · 1c9cada
1 parent a43d43a
commit 1c9cada
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/encoding/deno.json b/encoding/deno.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.0.1",
+  "version": "0.0.2",
   "name": "@stdext/encoding",
   "lock": false,
   "exports": {

diff --git a/encoding/hex.ts b/encoding/hex.ts
@@ -1,3 +1,14 @@
+/**
+ * Utilities for hex encoded data.
+ * @module
+ *
+ * ```ts
+ * import { dump } from "@stdext/encoding/hex";
+ * const buffer = new TextEncoder().encode("Hello world!");
+ * console.log(dump(buffer));
+ * ```
+ */
+
 /**
  * Convert a buffer to a hexdump string.
  *