@danielzfliu/memory 1.0.0 → 1.0.1

package/README.md

@@ -1,3 +1,5 @@
+[![npm version](https://img.shields.io/npm/v/@danielzfliu/memory.svg)](https://www.npmjs.com/package/@danielzfliu/memory)
+
 # Memory
 A fully local Node.js library and REST API for storing, searching, and querying tagged text pieces using ChromaDB for vector storage and Ollama for embeddings + generation.
 
@@ -8,46 +10,45 @@ A fully local Node.js library and REST API for storing, searching, and querying
 - **ChromaDB** server running locally
 
 ### Start Ollama & pull models
-
+To pull models, run:
 ```bash
 ollama pull nomic-embed-text-v2-moe
 ollama pull llama3.2
-npm run ollama
 ```
 
-or on a specific port:
-
+If used as api:
 ```bash
+npm run ollama # or
 npm run ollama:port 11435
 ```
 
-### Start ChromaDB
+If used as a npm package:
 ```bash
-npm run db
+ollama serve
 ```
 
-or on a specific port:
-
+### Start ChromaDB
+If used as api:
 ```bash
+npm run db # or
 npm run db:port 9000
 ```
 
+If used as a npm package:
+```bash
+chroma run --port 8000
+```
+
 **Windows note:** If `chroma` is not recognized, the `Scripts` directory may not be on your PATH. Either add it (e.g. `%APPDATA%\Python\Python3xx\Scripts`) or run the executable directly:
 ```powershell
 & "$env:APPDATA\Python\Python313\Scripts\chroma.exe" run --port 8000
 ```
 
-## Install
-
-```bash
-npm install
-```
-
 ## Usage
 
 ### REST API Server
-
 ```bash
+npm install
 npm run dev
 ```
 
@@ -116,7 +117,7 @@ Returns:
 ### Programmatic Usage (Library)
 
 ```typescript
-import { PieceStore, RagPipeline, MemoryConfig } from "memory";
+import { PieceStore, RagPipeline, MemoryConfig } from "@danielzfliu/memory";
 
 async function main() {
     const config: MemoryConfig = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@danielzfliu/memory",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "A local RAG system for storing, searching, and querying tagged text pieces using ChromaDB and Ollama",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -13,8 +13,7 @@
     "files": [
         "dist",
         "README.md",
-        "LICENSE",
-        "package_scripts"
+        "LICENSE"
     ],
     "repository": {
         "type": "git",

package/package_scripts/serve-chroma.js

@@ -1,17 +0,0 @@
-const { spawn } = require("child_process");
-
-// Get port from argument or default to 8000
-const port = process.argv[2] || "8000";
-
-console.log(`🚀 Starting ChromaDB on port ${port}`);
-
-const command = `chroma run --port ${port}`;
-
-const child = spawn(command, [], {
-    stdio: "inherit",
-    shell: true,
-});
-
-child.on("close", (code) => {
-    process.exit(code);
-});

package/package_scripts/serve-ollama.js

@@ -1,20 +0,0 @@
-const { spawn } = require("child_process");
-
-// Get the port from the command line argument, or default to 11434
-const port = process.argv[2] || "11434";
-
-console.log(`🚀 Starting Ollama on 127.0.0.1:${port}`);
-
-// Run the command with the modified environment variable
-const child = spawn("ollama serve", [], {
-    stdio: "inherit", // Show Ollama's output in your terminal
-    shell: true, // Ensure compatibility across OS
-    env: {
-        ...process.env, // Keep existing environment variables
-        OLLAMA_HOST: `127.0.0.1:${port}`,
-    },
-});
-
-child.on("close", (code) => {
-    process.exit(code);
-});