Skip to content

Commit 4ad80d9

Browse files
committed
Add CI and README package links
1 parent d4b64fe commit 4ad80d9

2 files changed

Lines changed: 58 additions & 2 deletions

File tree

.github/workflows/ci.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
test:
16+
name: Test on Node ${{ matrix.node-version }}
17+
runs-on: ubuntu-latest
18+
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
node-version:
23+
- 20
24+
- 22
25+
26+
steps:
27+
- name: Check out repository
28+
uses: actions/checkout@v4
29+
30+
- name: Set up Node
31+
uses: actions/setup-node@v4
32+
with:
33+
node-version: ${{ matrix.node-version }}
34+
cache: npm
35+
36+
- name: Install dependencies
37+
run: npm ci
38+
39+
- name: Typecheck
40+
run: npm run typecheck
41+
42+
- name: Build
43+
run: npm run build
44+
45+
- name: Test
46+
run: npm test

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
11
# text-similarity-kit
22

3+
[![npm version](https://img.shields.io/npm/v/text-similarity-kit.svg)](https://www.npmjs.com/package/text-similarity-kit)
4+
[![License: MPL-2.0](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](LICENSE)
5+
[![CI](https://github.com/Recoveredd/text-similarity-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/Recoveredd/text-similarity-kit/actions/workflows/ci.yml)
6+
37
Compare and rank short strings with a small TypeScript-first toolkit.
48

59
`text-similarity-kit` is a clean-room alternative for everyday fuzzy matching tasks: search suggestions, typo-tolerant labels, command palettes, duplicate detection and lightweight record matching. It ships as ESM, has no runtime dependencies and works in Node.js or modern browsers.
610

7-
## Demo
11+
Links: [Demo](https://packages.wasta-wocket.fr/text-similarity-kit/) · [npm](https://www.npmjs.com/package/text-similarity-kit) · [GitHub](https://github.com/Recoveredd/text-similarity-kit)
12+
13+
## Package quality
814

9-
Try the browser demo: https://packages.wasta-wocket.fr/text-similarity-kit/
15+
- TypeScript types are generated from the source.
16+
- ESM-only package with no runtime dependencies.
17+
- Marked as side-effect free for bundlers.
18+
- Tested on Node.js 20 and 22 with GitHub Actions.
19+
- Works in Node.js, browsers, Vite apps and static docs tooling.
1020

1121
## Install
1222

0 commit comments

Comments
 (0)