Add docs for root module.

paulmillr · Jan 3, 2025 · 83c1ed5 · 83c1ed5
1 parent 5601c71
commit 83c1ed5
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/index.ts b/src/index.ts
@@ -1 +1,6 @@
-throw new Error('noble-post-quantum has no entry-point: consult README for usage');
+/**
+ * Auditable & minimal JS implementation of post-quantum public-key cryptography.
+ * Check out individual modules.
+ * @module
+ */
+throw new Error('root module cannot be imported: import submodules instead. Check out README');