docs: add reference to langfuse-core

langfuse · Mar 24, 2024 · 59b8a55 · 59b8a55
1 parent 7b5f221
commit 59b8a55
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/langfuse-core/README.md b/langfuse-core/README.md
@@ -1,11 +1,15 @@
 # Langfuse Core
 
+[![npm package](https://img.shields.io/npm/v/langfuse-core?style=flat-square)](https://www.npmjs.com/package/langfuse-core)
+
 This is the core package for the Langfuse JS/TS client libraries. It is not meant to be used directly.
 
+Reference: https://js-core.reference.langfuse.com
+
 **Client Libraries**
 
-| Package                                    | NPM                                                                                                                                   | Environments          |
-| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| [langfuse](./langfuse)                     | [![npm package](https://img.shields.io/npm/v/langfuse?style=flat-square)](https://www.npmjs.com/package/langfuse)                     | Node >= 18, Web, Edge |
-| [langfuse-node](./langfuse-node)           | [![npm package](https://img.shields.io/npm/v/langfuse-node?style=flat-square)](https://www.npmjs.com/package/langfuse-node)           | Node < 18             |
-| [langfuse-langchain](./langfuse-langchain) | [![npm package](https://img.shields.io/npm/v/langfuse-langchain?style=flat-square)](https://www.npmjs.com/package/langfuse-langchain) | Node >= 20, Web, Edge |
+| Package                                                                                    | NPM                                                                                                                                   | Environments          |
+| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
+| [langfuse](https://github.com/langfuse/langfuse-js/tree/main/langfuse)                     | [![npm package](https://img.shields.io/npm/v/langfuse?style=flat-square)](https://www.npmjs.com/package/langfuse)                     | Node >= 18, Web, Edge |
+| [langfuse-node](https://github.com/langfuse/langfuse-js/tree/main/langfuse-node)           | [![npm package](https://img.shields.io/npm/v/langfuse-node?style=flat-square)](https://www.npmjs.com/package/langfuse-node)           | Node < 18             |
+| [langfuse-langchain](https://github.com/langfuse/langfuse-js/tree/main/langfuse-langchain) | [![npm package](https://img.shields.io/npm/v/langfuse-langchain?style=flat-square)](https://www.npmjs.com/package/langfuse-langchain) | Node >= 20, Web, Edge |
diff --git a/langfuse-core/package.json b/langfuse-core/package.json
@@ -25,7 +25,8 @@
   },
   "scripts": {
     "test": "jest -c jest.config.js",
-    "prepublishOnly": "cd .. && yarn build"
+    "prepublishOnly": "cd .. && yarn build",
+    "docs": "cd .. && yarn build && cd langfuse-core && typedoc index.ts"
   },
   "files": [
     "lib",