@synth-coder/memhub 0.1.0 → 0.1.1

package/README.md

@@ -18,30 +18,34 @@ MemHub stores decisions, preferences, and reusable knowledge as plain Markdown f
 ## Features
 
 - Markdown-based memory storage (`.md`)
-- YAML Front Matter metadata (`id`, `tags`, `category`, `importance`, timestamps)
-- CRUD operations for memory entries
-- Filtering, pagination, and full-text search
-- Category/tag aggregation
+- YAML Front Matter metadata (`id`, `session_id`, `entry_type`, `tags`, `category`, `importance`, timestamps)
+- STM-first 2-tool interface: `memory_load` + `memory_update`
+- Concurrent CLI-safe storage layout: `YYYY-MM-DD/session_uuid/...`
 - MCP stdio server compatible with MCP clients
 
 ---
 
 ## Quick Start
 
-### 1) Install dependencies
+### 1) Install from npm
+
+```bash
+npm i @synth-coder/memhub
+```
+
+### 2) Or install dependencies for local development
 
 ```bash
 npm install
 ```
 
-### 2) Build
+### 3) Build
 
 ```bash
 npm run build
 ```
 
-### 3) Run quality gate
-
+### 4) Run quality gate
 ```bash
 npm run quality
 ```
@@ -50,14 +54,22 @@ npm run quality
 
 ## Use as MCP Server (stdio)
 
+### Option A: run directly via npx (recommended)
+
+```bash
+npx -y @synth-coder/memhub
+```
+
+> On Windows, do **not** append `memhub` after the package name.
+
 Example MCP client config:
 
 ```json
 {
   "mcpServers": {
     "memhub": {
-      "command": "node",
-      "args": ["dist/server/mcp-server.js"],
+      "command": "npx",
+      "args": ["-y", "@synth-coder/memhub"],
       "env": {
         "MEMHUB_STORAGE_PATH": "/absolute/path/to/memories",
         "MEMHUB_LOG_LEVEL": "info"
@@ -67,7 +79,18 @@ Example MCP client config:
 }
 ```
 
-> If you publish to npm and install globally, you can also run through your package bin entry.
+### Option B: local repo run
+
+```json
+{
+  "mcpServers": {
+    "memhub": {
+      "command": "node",
+      "args": ["dist/src/server/mcp-server.js"]
+    }
+  }
+}
+```
 
 ---
 
@@ -162,7 +185,7 @@ memhub/
 - [x] Quality gate (lint/typecheck/test/coverage)
 - [ ] Integration tests
 - [ ] Performance improvements
-- [ ] npm release
+- [x] npm release (`@synth-coder/memhub@0.1.1`)
 
 ---
 

package/README.zh-CN.md

@@ -18,30 +18,34 @@ MemHub 将“用户决策、长期偏好、可复用知识”保存为 **Markdow
 ## 核心特性
 
 - Markdown 持久化（`.md`）
-- YAML Front Matter 元数据（`id / tags / category / importance / 时间戳`）
-- 记忆条目的增删改查（CRUD）
-- 支持过滤、分页、全文检索
-- 分类/标签聚合能力
+- YAML Front Matter 元数据（`id / session_id / entry_type / tags / category / importance / 时间戳`）
+- STM-first 双工具接口：`memory_load` + `memory_update`
+- 并发 CLI 安全目录：`YYYY-MM-DD/session_uuid/...`
 - MCP stdio server，可接入主流 MCP 客户端
 
 ---
 
 ## 快速开始
 
-### 1）安装依赖
+### 1）从 npm 安装
+
+```bash
+npm i @synth-coder/memhub
+```
+
+### 2）本地开发安装依赖
 
 ```bash
 npm install
 ```
 
-### 2）构建
+### 3）构建
 
 ```bash
 npm run build
 ```
 
-### 3）执行质量门禁
-
+### 4）执行质量门禁
 ```bash
 npm run quality
 ```
@@ -50,14 +54,22 @@ npm run quality
 
 ## 作为 MCP Server 使用（stdio）
 
+### 方式 A：npx 直接运行（推荐）
+
+```bash
+npx -y @synth-coder/memhub
+```
+
+> Windows 下不要在包名后再加 `memhub` 参数。
+
 在你的 MCP 客户端配置中添加：
 
 ```json
 {
   "mcpServers": {
     "memhub": {
-      "command": "node",
-      "args": ["dist/server/mcp-server.js"],
+      "command": "npx",
+      "args": ["-y", "@synth-coder/memhub"],
       "env": {
         "MEMHUB_STORAGE_PATH": "/绝对路径/你的记忆目录",
         "MEMHUB_LOG_LEVEL": "info"
@@ -67,7 +79,18 @@ npm run quality
 }
 ```
 
-> 若后续发布到 npm 并全局安装，也可以改为通过包的 bin 入口启动。
+### 方式 B：本地仓库运行
+
+```json
+{
+  "mcpServers": {
+    "memhub": {
+      "command": "node",
+      "args": ["dist/src/server/mcp-server.js"]
+    }
+  }
+}
+```
 
 ---
 
@@ -160,7 +183,7 @@ memhub/
 - [x] 质量门禁（lint/typecheck/test/coverage）
 - [ ] 集成测试
 - [ ] 性能优化
-- [ ] npm 发布
+- [x] npm 发布（`@synth-coder/memhub@0.1.1`）
 
 ---
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@synth-coder/memhub",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A Git-friendly memory hub using Markdown-based storage with YAML Front Matter",
   "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
   "bin": {
-    "memhub": "dist/server/mcp-server.js"
+    "memhub": "dist/src/server/mcp-server.js"
   },
   "scripts": {
     "build": "tsc",