ownsearch 0.1.0 → 0.1.2

package/README.md

@@ -1,34 +1,36 @@
 # ownsearch
 
-`ownsearch` is a text-first local semantic search package that indexes folders into Qdrant and exposes retrieval tools through an MCP server.
+**ownsearch** is a local search layer for agents.
 
-V1 scope:
+It indexes approved folders into a local Qdrant store, exposes retrieval through an MCP server, and lets your agents search private knowledge without a hosted search service.
 
-- text and code files first
-- extracted text from PDFs
-- Gemini embeddings with `gemini-embedding-001`
-- Docker-backed Qdrant storage
-- stdio MCP server for agent attachment
+V1 is intentionally text-first: simple, reliable local retrieval for docs, code, and PDFs. Over time, **ownsearch** will expand to support multimodal files and data, including images, audio, video, and richer cross-modal search workflows.
 
-## Install
+## What it does
 
-For local development before publish:
+- Indexes local folders into a persistent vector store
+- Chunks and embeds supported files with Gemini
+- Supports incremental reindexing for changed and deleted files
+- Exposes search and context retrieval through MCP
+- Lets agents retrieve ranked hits, exact chunks, or grounded context bundles
 
-```bash
-npm install
-npm run build
-npm link
-```
+## V1 scope
 
-After publish, the intended install is:
+- text and code files
+- extracted text from PDFs
+- Gemini `gemini-embedding-001`
+- Docker-backed Qdrant
+- stdio MCP server for local agent attachment
+
+## Quickstart
+
+Install `ownsearch` globally:
 
 ```bash
 npm install -g ownsearch
-```
 
-## Quickstart
+Set it up, index a folder, and start searching:
 
-```bash
 ownsearch setup
 ownsearch doctor
 ownsearch index ./docs --name docs
@@ -36,33 +38,49 @@ ownsearch list-roots
 ownsearch search "what is this repo about?" --limit 5
 ownsearch search-context "what is this repo about?" --limit 8 --max-chars 12000
 ownsearch serve-mcp
-```
 
-## Agent Config
+To connect ownsearch to a supported agent, print a config snippet for your client:
 
-Print a config snippet for your agent:
+ownsearch print-agent-config codex
+ownsearch print-agent-config claude-desktop
+ownsearch print-agent-config cursor
+Local development
 
-```bash
-node dist/cli.js print-agent-config codex
-node dist/cli.js print-agent-config claude-desktop
-node dist/cli.js print-agent-config cursor
-```
+If you want to run ownsearch from source while developing locally:
 
-## MCP Tools
+npm install
+npm run build
+node dist/cli.js setup
+node dist/cli.js index ./docs --name docs
+node dist/cli.js search "what is this repo about?" --limit 5
+node dist/cli.js serve-mcp
 
-- `index_path`
-- `search`
-- `search_context`
-- `get_chunks`
-- `list_roots`
-- `delete_root`
-- `store_status`
+## MCP tools
 
-`index_path` is incremental. Re-running it on the same folder only re-embeds changed files and removes stale chunks.
+* `index_path`
+* `search`
+* `search_context`
+* `get_chunks`
+* `list_roots`
+* `delete_root`
+* `store_status`
 
 ## Notes
 
-- Roots are stored in `~/.ownsearch/config.json`.
-- Qdrant runs in Docker under the container name `ownsearch-qdrant`.
-- Each indexed folder is stored as payload-filtered chunks inside a single Qdrant collection.
-- Agents can call `search_context` for a ready-to-use context bundle, or call `search` first and then `get_chunks` for exact chunk retrieval.
+* Config is stored in `~/.ownsearch/config.json`
+* Qdrant runs locally in Docker as `ownsearch-qdrant`
+* `GEMINI_API_KEY` must be available in the environment or `.env`
+
+## Roadmap
+
+Planned after the text-first v1:
+
+* richer document extraction
+* better reranking and deduplication
+* watch mode for automatic reindexing
+* HTTP MCP transport
+* multimodal indexing for images, audio, video, and richer document formats
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ownsearch",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Text-first local document search MCP server backed by Gemini embeddings and Qdrant.",
   "type": "module",
   "bin": {
@@ -30,7 +30,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@personal/Grumppie/OwnSearch.git"
+    "url": "https://github.com/Grumppie/OwnSearch.git"
   },
   "homepage": "https://github.com/Grumppie/OwnSearch#readme",
   "bugs": {