md-semantic-search 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +21 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # md-semantic-search
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/md-semantic-search.svg)](https://www.npmjs.com/package/md-semantic-search)
4
+ [![npm downloads](https://img.shields.io/npm/dm/md-semantic-search.svg)](https://www.npmjs.com/package/md-semantic-search)
5
+ [![publish](https://github.com/chelslava/md-semantic-search/actions/workflows/publish.yml/badge.svg)](https://github.com/chelslava/md-semantic-search/actions/workflows/publish.yml)
6
+ [![node](https://img.shields.io/node/v/md-semantic-search.svg)](https://nodejs.org)
7
+ [![license](https://img.shields.io/npm/l/md-semantic-search.svg)](./LICENSE)
8
+
3
9
  **Local, private semantic (vector) search over any folder of Markdown files.**
4
10
 
5
11
  Find passages by *meaning*, not just keywords — and across languages (ask in
@@ -157,6 +163,21 @@ Switching models invalidates the stored vectors automatically — the next
157
163
  No external services, no database — the whole index is one JSON file and search
158
164
  is an in-memory dot-product sweep.
159
165
 
166
+ ## Releasing (maintainers)
167
+
168
+ Publishing is automated by [`.github/workflows/publish.yml`](./.github/workflows/publish.yml):
169
+ pushing a `vX.Y.Z` tag publishes that version to npm with provenance.
170
+
171
+ One-time setup: add a repo secret `NPM_TOKEN` — an npm **automation / granular**
172
+ token with *bypass 2FA* enabled (npmjs.com → Account → Access Tokens).
173
+
174
+ ```bash
175
+ npm version patch # bumps package.json + creates the git tag
176
+ git push --follow-tags
177
+ ```
178
+
179
+ The workflow checks that the tag matches `package.json` before publishing.
180
+
160
181
  ## License
161
182
 
162
183
  MIT © chelslava
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "md-semantic-search",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Local, private semantic (vector) search over any folder of Markdown files. Finds passages by meaning — cross-lingual — using transformers.js. No API keys, no cloud, no vector database.",
5
5
  "type": "module",
6
6
  "bin": {