From 2b9f2c2619cab42609ae2b86c9dc91471460ba25 Mon Sep 17 00:00:00 2001
From: Himanshu Shekhar
Date: Fri, 18 Sep 2026 04:35:09 +0530
Subject: [PATCH 1/4] docs(readme): rebuild on the shared q1k-oss skeleton
Same structure as the other three q1k-oss packages. Replaces the
dark-tile logo with the bare leaf from the open-source page, traced to
a vector so it scales; the old .github/logo.png is unreferenced now and
is removed.
---
.github/logo-dark.svg | 1 +
.github/logo.png | Bin 4299 -> 0 bytes
.github/logo.svg | 1 +
README.md | 432 ++++++++++++++++--------------------------
4 files changed, 161 insertions(+), 273 deletions(-)
create mode 100644 .github/logo-dark.svg
delete mode 100644 .github/logo.png
create mode 100644 .github/logo.svg
diff --git a/.github/logo-dark.svg b/.github/logo-dark.svg
new file mode 100644
index 0000000..91b1465
--- /dev/null
+++ b/.github/logo-dark.svg
@@ -0,0 +1 @@
+
diff --git a/.github/logo.png b/.github/logo.png
deleted file mode 100644
index 81b76217742d75a2d51e4127c04f7a4fc759f6b7..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 4299
zcmcIoYaT-6g^p4N}q}KWZRIBPB?ugp?pT=>{oL
z%9rLYzJs!^G5}DQM0#Tl1^^&d+G@&(0N~;Keebjj
z=-{`8%jJV8c9$bykGwiBvJqng)!BWE#0r|q9>(h}?tT)yX8!O``OWe!pF^dOQ(59V
zmJC!xqo$_R?_sIpwh^*?eKdV`EB{yx0eiPGFaKIW?->!rd|=1xqt3I29fHrFKQlGE
zUen)sNrw8oD_Y{HETg*FjTl@HENp9&^}Ibc@wW8w^P2^ScW?h0=}a!-X9yj$6%k~o
zj3vJ5A%d)t;)4kJM;4yN)pvEV+BeJ}LJA3S=uM*&o_O%57pG0Oo}+WaaqVhx^+UCg
z=3bD3X51Rc<&WR%KbCtz(B=RF8Uyf$7WJ}d>V9uqUWOp%$AmyNpw6)WO?0339yH5@QVfm{b}ix{*);NNU%=bK1$TO8B%|DAic~7CuI)xQR>?U6&@A`@_9LQ;4my&anm7Q&7{BR{&^Z
zSqFWyZGp1GAFvHk5-zSqx=G@Oi+glnRg14)J;Ji-ZNJZ?{YDC7k{0Irc20MBsAx?s
z0!a`+m{4s%%yC>KtGK_${96C+%Ao0oH@<1X40H7Hk}0{
zJ9xCH*yu?D?05{oe;8|@UbIuUEdnwPj&PGI&^7AK$Tw7do?_biV)6rsB#2#$#7&InQUVhD6IDXMzc
zhI)wkw6@I^>#As}@&0mVwS%;Jb8~e2?>OB06&otK+L@%z_d*8zDk)D*4IGf$wO3d@
z*WMo0bZDV*`L86sD9^T}b)&vEV^~7n5vlxX&tUC@5P^P<$Nvb$$IFt-25_O(ThCwTxi5~+w=liemya=ceXq?9IriyJ{6pQO7`}*oKqrDVMKTh?d
zOWjj1kHd=tOz$Lsw#-4BlDEqpcp=-eH2d6e;UqU5g>Vy|6_U>O7Fp^)$5i?vJGID?
zbY{^NB)>F}NRz|{$XQ`--C6TTsY#?tDJHv{V!ovi6K^|?JDs^HH%yC07sh#x$IbC=u
zWyK4$w`#FAtlaA0%^dUG)PUxieG4E}U^A-UP>E$@9Zu%2ivIxoq6{D~SkZObSQR@p
z9crQZxM^U_`pMg&%=NQK?C<*Pgjw)g*$gkOa$fS%+=y@i%k_Gq+XH>eIC83?%`1bG
zs1vX}r(S=ojF+r%4p)Ufn!B;~&%_e$;<|AQ$xaE0si_pk(#3Mx2r60fTE1z^GD
zRnCd;&TfQ9Z42rrfy@eyRQqeoDVh2C8o0_iqTJQ}$)$dYrb=V%;rBAtSilSN1DE29
zykIM?cz8$*l%*+2!cT3~hjfjz4+BlwY_az3w$m$2vt7D&6m6`E^QsG6)vpmC7$ba58@$nVinJf(a>zy4B+_E{4H6}KL`mJ;&QH1XQ%c8Z6-j+xzI
zwiBC&&4g=!`iUXaqjjGFRiB$XsIQ5$Ej6zn?1xOYNlZqNf#axHOx+mG8^;a5`ux>z
zU4k)<1bRQom840wWqFFuq6>3&vSbvkk|eIfF}&C%5oCDMwV!snp+*cbemnzvkn`i%
zbn*p}mP($iT0Lof1zYJA1R6p)I6z?_SW|5x?%1tEY)nlI(KN1
zVepY920xr(k;3X`$}|v6?=maf7wyz}oq1BcJ|c)`ir`P-Bid+x_CPC9O#f~3M`Qc3
z0Q&JpE#*Xjt3$NK+Xky`n1un(^L)Yl?IxaZg{y;y8(q8L+M^Ez&zrZi7g8Y&98hgIFv}zag4T#5O&uAXlg-8ffvQ9kVE%$nv0NN
z%$~4DABeukzzyU5EfVsk%-
z=gTtJ9>6Jnf8{lM6M)x!QG~nhoC|s-Bs>xuqdzNA^cb><;k%t^Y6YiS_G-FcPRE9a
zGr*DdwJN5&n?Y)=Kc9ve46U#UE55(BO?!Btowc3`gsJG{?A>vy5lzs^FN$yt9H2Pz
zGi$l2FS1+QaXOifE<$6~$c{f~I?@=2$neD-3}PXW7}YByoK`6LFC>4QiMd!P-cUs%
zRCb7hg|8N!fP~J1yH^AG^%aNQF3-rL#>B}uk3Le`wpfXxO-p8c##@KmRVp>P_arY<
z4?;PVHCGNe1i2W2uvSF){(IFZFu%azxP6?x$Y;v)=q&PW+28-ztnstPew5xB>#pH>
z@v}TuXlP2bo$mjtn+a`1i0ebt|SxcO8eGqd+qm+YT^1dH0DzS~JR
z$9#JxMKi(M(3~y}>%wLXPx5~`^TIsr42ewTxYlVltJ+G6Ao751=!|c?4_~yi1?WbH
z3*f$wG@K9M#wUkWd$$IP4blgKC0V!XRUBctU#AbK{Z(7|Y|^_E-gTho$lh7p*}Uub
z&(~w77tXF$M3`eUa-V3TEkP7mJrr-=aiFS7^A%EwEn%%}YAYL`!?afOt?`
zW(-Ba;K4V(i4Cm*Y1)H~#~Sq%7umVeios_jhwJyI1$x@fEP0i$U6Ww&wd~pU&XEIh
zwyDH|r&0KM>s^skY%ZNPgr+nV+Y{Bb1_3U=~icsX6K4
zji@pnt%FIxiZfv>A{duQ2L!cr%?~r^CX`5T#R&w2(K?F=HAh!HKfe1Io!GJL?q*kE
z0)JEnUtOj&1oeq&+e_#hp?l6sjHm6F;Au)k+_PtG@BWr5p||F8YO?w26-LzE2uJGp=2(xy9w@){C_LqE
zqfyPa13wH&&NUOaw0C{*#aib4m`NtoX6c69z%T6D_+(kS2%o4RjHgMfVTpD?!JHH;kIiDx&wHJjh{aSKUfZ}dg
z;pnX9$A>yz#_XCWi9@>UN=U7@nuV@W=KTL1Fqb4P4;+6!GE-_G7Z#amIO?))}$tvB_mX1l$R_4!@9r+bf@N~6iEP1%cy>REH
zt1}PvRYkAMF`LQfJ^6d{ONcSl0X-ffX0P|XaCZBFtWF{#m^29qWIfuKmFyo@OEo!7
z)rCH@kFW6zxMdg&{Gk%bvso@&z3b`xp!jUg;6#8#1Uy7jlPqX({P)$%&7u~?h;`|_
ztbJ*D?Xs1}MMlxpQwI89&y$LMf$$~e5&-ZW#SGqH^wdm~jK;QpVs3i#kV~|*0)F8K
z<8`@A3O=QS=K~R9O9x;YT$#(omEdSr16zn+?^cgu!WnANv@_((sHVZAi0-CJmr|<*
zhb)_vfH@5gwpq|P2gMGiK#~72Lz`y^YDEmS2xRmB*9oWi|H_~D36^Q3p0b4d$fM`w
z;&0~?ZdliXERggMGn|_CSAd*gfTo59t`L-+zKTgvvP(G#RuF^9RS2v3>X{eA!d
diff --git a/.github/logo.svg b/.github/logo.svg
new file mode 100644
index 0000000..91b1465
--- /dev/null
+++ b/.github/logo.svg
@@ -0,0 +1 @@
+
diff --git a/README.md b/README.md
index 1c25c51..413dd0f 100644
--- a/README.md
+++ b/README.md
@@ -1,53 +1,46 @@
-# MINT Format
-
-
+
+
+
+
-
- Minimal Inference Notation for Tokens
-
+@q1k-oss/mint-format
+
+~45% fewer tokens than JSON
- A fresh, human-readable, token-efficient data format for LLM prompts.
- Combines YAML simplicity with Markdown table clarity.
+ MINT — Minimal Inference Notation for Tokens.
+ YAML-style objects and Markdown-style tables. Lossless round-trip to JSON, readable with no learning curve.
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
- Live Playground ·
- Specification ·
- npm
+ Playground ·
+ Spec ·
+ npm ·
+ GitHub ·
+ q1k-oss
---
-## Why MINT?
-
-Modern LLMs are powerful but **tokens cost money**. Existing formats force a tradeoff:
+## Overview
-| Format | Problem |
-|--------|---------|
-| **JSON** | Verbose — ~40% overhead from braces, quotes, repeated keys |
-| **YAML** | Better — but arrays of objects still repeat every key |
-| **TOON** | Efficient — but cryptic syntax, hard to read |
-| **CSV** | Compact — but no structure, can't nest |
+Tokens cost money, and every existing format makes you trade something away. JSON spends
+roughly 40% of its characters on braces, quotes and repeated keys. YAML fixes some of that
+but still repeats every key in an array of objects. TOON is compact but cryptic. CSV is
+compact and has no structure at all.
-**MINT** gives you the best of all worlds:
+MINT takes the two notations people already read fluently — YAML-style key/value blocks and
+Markdown-style tables — and uses each where it is strongest. Objects nest as YAML. Arrays of
+similar objects become a table, so the column names appear once instead of once per row.
```mint
workflow:
@@ -69,114 +62,121 @@ messages:
| assistant | Found 3 discrepancies. Please review.|
```
-**47% smaller than JSON** with **zero learning curve**.
+That is about 47% smaller than the equivalent JSON, and you did not have to learn anything
+to read it.
----
+### Benchmarks
-## Key Features
+| Dataset | JSON | MINT | Savings |
+| --- | --- | --- | --- |
+| User records (100 rows) | 3,245 | 1,756 | **46%** |
+| API responses (50 items) | 2,891 | 1,534 | **47%** |
+| Workflow states (25 steps) | 1,567 | 892 | **43%** |
+| Nested configs | 892 | 523 | **41%** |
+| **Average** | — | — | **~45%** |
-- **Fresh & Clean** — Instantly readable, no learning curve
-- 📉 **47% Fewer Tokens** — Significant cost savings on LLM APIs
-- 👁️ **Crystal Clear** — Visible `|` boundaries, Markdown tables
-- ✏️ **Edit-Friendly** — No invisible tabs, no alignment headaches
-- 🔄 **Lossless** — Perfect JSON round-trip
-- 🚀 **Fast** — Simple parsing, zero dependencies
-- 📦 **Tiny** — ~5KB minified
+Four things do the work:
----
+1. **Table headers once** — column names live in the header row, not in every record.
+2. **No repeated braces** — rows are delimited by `|`, not wrapped in `{}`.
+3. **Minimal quoting** — most values are unquoted.
+4. **Tokeniser-friendly structure** — pipes tokenise cleanly in practice.
-## Table of Contents
+### Compared with other formats
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [Format Overview](#format-overview)
-- [CLI Usage](#cli-usage)
-- [API Reference](#api-reference)
-- [Benchmarks](#benchmarks)
-- [Specification](#specification)
-- [Comparison](#comparison-with-other-formats)
-- [Contributing](#contributing)
+
+JSON MINT
+
----
+```json
+{
+ "users": [
+ { "id": 1, "name": "Alice" },
+ { "id": 2, "name": "Bob" }
+ ]
+}
+```
+
+
+
+```mint
+users:
+ | id | name |
+ | 1 | Alice |
+ | 2 | Bob |
+```
-## Installation
+
+
+
+| Against | Result |
+| --- | --- |
+| **JSON** | ~47% smaller, equally readable |
+| **YAML** | ~35% smaller for arrays of objects |
+| **TOON** | ~15% larger, far more readable |
+
+Reach for MINT when you are sending structured data to an LLM, paying per token, want a
+prompt a human can still read, or want clean diffs in version control. Reach for something
+else when you need maximum compression (TOON), API interoperability (JSON), or binary data
+(MessagePack).
+
+## Highlights
+
+- **~45% fewer tokens than JSON** — measurable savings on every LLM call.
+- **No learning curve** — if you can read YAML and a Markdown table, you can read MINT.
+- **Lossless** — perfect round-trip back to JSON.
+- **Zero dependencies** — ~5 KB minified.
+- **Typed** — TypeScript encoder and decoder with full declarations.
+- **CLI included** — convert files or pipe through stdin, with a `--stats` mode.
+
+## Install
```bash
-# npm
npm install @q1k-oss/mint-format
-
-# pnpm
+# or
pnpm add @q1k-oss/mint-format
-
-# yarn
+# or
yarn add @q1k-oss/mint-format
+```
+
+The CLI needs no install:
-# CLI (no install needed)
+```bash
npx @q1k-oss/mint-format-cli input.json -o output.mint
```
----
-
-## Quick Start
+## Quick start
-### Encode (JSON → MINT)
+Encode JSON to MINT:
```typescript
import { encode } from '@q1k-oss/mint-format';
-const data = {
+const mint = encode({
users: [
{ id: 1, name: 'Alice', role: 'admin' },
- { id: 2, name: 'Bob', role: 'user' },
- { id: 3, name: 'Charlie', role: 'user' }
- ]
-};
-
-console.log(encode(data));
-```
-
-**Output:**
+ { id: 2, name: 'Bob', role: 'editor' },
+ ],
+});
-```mint
-users:
- | id | name | role |
- | 1 | Alice | admin |
- | 2 | Bob | user |
- | 3 | Charlie | user |
+// users:
+// | id | name | role |
+// | 1 | Alice | admin |
+// | 2 | Bob | editor |
```
-### Decode (MINT → JSON)
+And back again:
```typescript
import { decode } from '@q1k-oss/mint-format';
-const mint = `
-users:
- | id | name | role |
- | 1 | Alice | admin |
- | 2 | Bob | user |
-`;
-
const data = decode(mint);
-console.log(JSON.stringify(data, null, 2));
-```
-
-**Output:**
-
-```json
-{
- "users": [
- { "id": 1, "name": "Alice", "role": "admin" },
- { "id": 2, "name": "Bob", "role": "user" }
- ]
-}
+// { users: [ { id: 1, name: 'Alice', role: 'admin' }, … ] }
```
----
-
-## Format Overview
+## Usage
-### Objects — YAML Style
+### Objects — YAML style
```mint
user:
@@ -186,7 +186,7 @@ user:
active: true
```
-### Nested Objects
+### Nested objects
```mint
config:
@@ -198,9 +198,9 @@ config:
ttl: 3600
```
-### Arrays of Objects — Markdown Tables
+### Arrays of objects — Markdown tables
-This is where MINT shines ✨
+This is where MINT earns its savings:
```mint
employees:
@@ -210,16 +210,16 @@ employees:
| 3 | Charlie | Sales | 80000 |
```
-### Simple Arrays — Inline
+### Simple arrays — inline
```mint
tags: typescript, javascript, nodejs
numbers: 1, 2, 3, 4, 5
```
-### Null Values
+### Null values
-Use `-` in tables:
+Use `-` in a table cell:
```mint
results:
@@ -228,9 +228,9 @@ results:
| 2 | Bob | - |
```
-### Compact Mode (Optional)
+### Compact mode
-Enable symbols for extra compression:
+Opt in to symbol substitution for a further squeeze:
```mint
# Standard
@@ -246,15 +246,13 @@ Enable symbols for extra compression:
| ✗ |
```
----
-
-## CLI Usage
+### CLI
```bash
# JSON to MINT
npx @q1k-oss/mint-format-cli input.json -o output.mint
-# MINT to JSON
+# MINT to JSON
npx @q1k-oss/mint-format-cli input.mint -o output.json
# Pipe from stdin
@@ -264,20 +262,16 @@ cat data.json | npx @q1k-oss/mint-format-cli > output.mint
npx @q1k-oss/mint-format-cli data.json --stats
```
-### Options
-
| Option | Description |
-|--------|-------------|
+| --- | --- |
| `-o, --output ` | Output file path |
| `-e, --encode` | Force JSON → MINT |
| `-d, --decode` | Force MINT → JSON |
| `--compact` | Enable symbol compression |
-| `--stats` | Show token count & savings |
+| `--stats` | Show token count and savings |
| `--indent ` | Indentation spaces (default: 2) |
----
-
-## API Reference
+## API reference
### `encode(value, options?): string`
@@ -285,9 +279,9 @@ npx @q1k-oss/mint-format-cli data.json --stats
import { encode } from '@q1k-oss/mint-format';
const mint = encode(data, {
- indent: 2, // Spaces per level (default: 2)
- compact: false, // Use symbols (default: false)
- sortKeys: false, // Sort object keys (default: false)
+ indent: 2, // spaces per level (default: 2)
+ compact: false, // use symbols (default: false)
+ sortKeys: false, // sort object keys (default: false)
});
```
@@ -297,7 +291,7 @@ const mint = encode(data, {
import { decode } from '@q1k-oss/mint-format';
const data = decode(mintString, {
- strict: true, // Throw on invalid syntax (default: true)
+ strict: true, // throw on invalid syntax (default: true)
});
```
@@ -321,128 +315,10 @@ const estimate = estimateTokens(data);
console.log(`Savings: ${estimate.savingsPercent}%`);
```
----
-
-## Benchmarks
-
-### Token Efficiency
-
-| Dataset | JSON | MINT | Savings |
-|---------|------|------|---------|
-| User records (100 rows) | 3,245 | 1,756 | **46%** |
-| API responses (50 items) | 2,891 | 1,534 | **47%** |
-| Workflow states (25 steps) | 1,567 | 892 | **43%** |
-| Nested configs | 892 | 523 | **41%** |
-| **Average** | - | - | **~45%** |
-
-### Why MINT is Efficient
-
-1. **Table headers once** — Column names only in header row
-2. **No repeated braces** — Tables use `|` not `{}` per row
-3. **Minimal quoting** — Most values unquoted
-4. **Visual structure** — Pipes tokenize well in LLMs
-
----
-
-## Comparison with Other Formats
-
-### vs JSON
-
-```json
-{
- "users": [
- { "id": 1, "name": "Alice" },
- { "id": 2, "name": "Bob" }
- ]
-}
-```
-
-```mint
-users:
- | id | name |
- | 1 | Alice |
- | 2 | Bob |
-```
-
-**MINT: 47% smaller, equally readable**
-
-### vs TOON
-
-```toon
-users[2]{id,name}:
- 1,Alice
- 2,Bob
-```
-
-```mint
-users:
- | id | name |
- | 1 | Alice |
- | 2 | Bob |
-```
-
-**MINT: ~15% larger, but far more readable**
-
-### vs YAML
-
-```yaml
-users:
- - id: 1
- name: Alice
- - id: 2
- name: Bob
-```
-
-```mint
-users:
- | id | name |
- | 1 | Alice |
- | 2 | Bob |
-```
-
-**MINT: 35% smaller for arrays of objects**
-
-### Summary
-
-```
- EFFICIENCY
- ▲
- TOON ● │
- │
- MINT ●────┼──── ✨ Best balance
- │
- YAML ● │
- │
- JSON ● │
- └────────────────► READABILITY
-```
-
----
-
-## When to Use MINT
-
-### ✅ Perfect For
-
-- Sending structured data to LLMs
-- Reducing token costs (API billing)
-- Human-readable LLM prompts
-- Arrays of similar objects
-- Agentic AI workflows
-- Version-controlled data (clean diffs)
-
-### ❌ Consider Alternatives
-
-- Maximum compression needed → TOON
-- API interoperability → JSON
-- Binary data → MessagePack
-
----
-
-## Specification
-
-See [SPEC.md](./SPEC.md) for the complete formal specification including ABNF grammar.
+### Grammar
-### Quick Reference
+[SPEC.md](./SPEC.md) carries the formal specification, including the ABNF grammar. The
+shape of it:
```
DOCUMENT := (STATEMENT)*
@@ -453,46 +329,56 @@ TABLE_HEADER := '|' (COLUMN '|')+ NEWLINE
TABLE_ROW := '|' (CELL '|')+ NEWLINE
```
----
-
-## Contributing
+## Development
-We welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md).
+A pnpm workspace with two packages: `packages/mint` (the encoder and decoder, published as
+`@q1k-oss/mint-format`) and `packages/cli` (published as `@q1k-oss/mint-format-cli`).
```bash
-# Setup
git clone https://github.com/q1k-oss/mint.git
cd mint
pnpm install
-# Dev
-pnpm test # Run tests
-pnpm build # Build all packages
-pnpm benchmark # Run benchmarks
+pnpm test # run the test suite
+pnpm build # build all packages
+pnpm benchmark # run the token benchmarks
+pnpm lint # eslint
+pnpm format # prettier
```
----
-
-## Roadmap
+Roadmap:
-- [x] TypeScript encoder/decoder
+- [x] TypeScript encoder and decoder
- [x] CLI tool
- [x] Comprehensive tests
+- [x] Online playground — [mint.q1k.ai](https://mint.q1k.ai)
- [ ] Python implementation
-- [ ] Go implementation
+- [ ] Go implementation
- [ ] Rust implementation
- [ ] VS Code extension
-- [x] Online playground — [mint.q1k.ai](https://mint.q1k.ai)
----
+## Contributing
-## License
+Contributions are welcome — see [CONTRIBUTING.md](./CONTRIBUTING.md).
-[MIT](./LICENSE) © 2025 MINT Format Contributors
+1. Fork the repository and clone your fork.
+2. Create a branch: `git checkout -b feat/my-change`.
+3. `pnpm install`, then `pnpm test` to confirm the suite is green.
+4. Anything that changes the format itself needs a matching change to [SPEC.md](./SPEC.md).
+5. Commit using [Conventional Commits](https://www.conventionalcommits.org/) and open a
+ pull request.
----
+## Related projects
-
- MINT Format
- Fresh data for LLMs. Keep it minimal.
-
+MINT is part of the q1k-oss family — see [q1k.ai/open-source](https://q1k.ai/open-source).
+
+| Package | What it does |
+| --- | --- |
+| [`@q1k-oss/mint-format`](https://github.com/q1k-oss/mint) | Token-efficient data format for LLM prompts |
+| [`@q1k-oss/context-engine`](https://github.com/q1k-oss/context-engine) | Turns conversations and files into a versioned knowledge graph |
+| [`@q1k-oss/behaviour-tree-workflows`](https://github.com/q1k-oss/behaviour-tree-workflows) | Declarative behaviour trees in YAML, durable via Temporal |
+| [`@q1k-oss/kiban`](https://github.com/q1k-oss/kiban) | React components on Radix primitives and Tailwind |
+
+## License
+
+[MIT](./LICENSE)
From cc64aa275e34770497068e648901cea4e86bfbbf Mon Sep 17 00:00:00 2001
From: Himanshu Shekhar
Date: Fri, 18 Sep 2026 04:47:53 +0530
Subject: [PATCH 2/4] docs(readme): the open-source page is at q1k.ai/oss
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 413dd0f..14e58fe 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@
Spec ·
npm ·
GitHub ·
- q1k-oss
+ q1k-oss
---
@@ -370,7 +370,7 @@ Contributions are welcome — see [CONTRIBUTING.md](./CONTRIBUTING.md).
## Related projects
-MINT is part of the q1k-oss family — see [q1k.ai/open-source](https://q1k.ai/open-source).
+MINT is part of the q1k-oss family — see [q1k.ai/oss](https://q1k.ai/oss).
| Package | What it does |
| --- | --- |
From 64c987093d79e532d67c36387019fb175d7a1de8 Mon Sep 17 00:00:00 2001
From: Himanshu Shekhar
Date: Fri, 18 Sep 2026 04:52:39 +0530
Subject: [PATCH 3/4] docs(readme): mint's repo is q1k-oss/mint-format
---
README.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 14e58fe..61ab325 100644
--- a/README.md
+++ b/README.md
@@ -17,15 +17,15 @@
-
-
+
+
Playground ·
- Spec ·
+ Spec ·
npm ·
- GitHub ·
+ GitHub ·
q1k-oss
@@ -335,7 +335,7 @@ A pnpm workspace with two packages: `packages/mint` (the encoder and decoder, pu
`@q1k-oss/mint-format`) and `packages/cli` (published as `@q1k-oss/mint-format-cli`).
```bash
-git clone https://github.com/q1k-oss/mint.git
+git clone https://github.com/q1k-oss/mint-format.git
cd mint
pnpm install
@@ -374,7 +374,7 @@ MINT is part of the q1k-oss family — see [q1k.ai/oss](https://q1k.ai/oss).
| Package | What it does |
| --- | --- |
-| [`@q1k-oss/mint-format`](https://github.com/q1k-oss/mint) | Token-efficient data format for LLM prompts |
+| [`@q1k-oss/mint-format`](https://github.com/q1k-oss/mint-format) | Token-efficient data format for LLM prompts |
| [`@q1k-oss/context-engine`](https://github.com/q1k-oss/context-engine) | Turns conversations and files into a versioned knowledge graph |
| [`@q1k-oss/behaviour-tree-workflows`](https://github.com/q1k-oss/behaviour-tree-workflows) | Declarative behaviour trees in YAML, durable via Temporal |
| [`@q1k-oss/kiban`](https://github.com/q1k-oss/kiban) | React components on Radix primitives and Tailwind |
From 8d9330e084ddbf78fb0aaa90ddeeefe570fbdbdd Mon Sep 17 00:00:00 2001
From: Himanshu Shekhar
Date: Fri, 18 Sep 2026 04:57:35 +0530
Subject: [PATCH 4/4] chore: point package metadata at q1k-oss/mint-format
The repo was renamed; npm still shows the old q1k-oss/mint URL, which
only resolves via GitHub's redirect.
---
package.json | 4 ++--
packages/cli/package.json | 4 ++--
packages/mint/package.json | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/package.json b/package.json
index 093fea7..769291d 100644
--- a/package.json
+++ b/package.json
@@ -16,10 +16,10 @@
"ai",
"minimal"
],
- "homepage": "https://github.com/q1k-oss/mint",
+ "homepage": "https://github.com/q1k-oss/mint-format#readme",
"repository": {
"type": "git",
- "url": "git+https://github.com/q1k-oss/mint.git"
+ "url": "git+https://github.com/q1k-oss/mint-format.git"
},
"license": "MIT",
"author": "MINT Format Contributors",
diff --git a/packages/cli/package.json b/packages/cli/package.json
index 140a110..31b6bad 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -9,10 +9,10 @@
"json",
"converter"
],
- "homepage": "https://github.com/q1k-oss/mint",
+ "homepage": "https://github.com/q1k-oss/mint-format#readme",
"repository": {
"type": "git",
- "url": "git+https://github.com/q1k-oss/mint.git",
+ "url": "git+https://github.com/q1k-oss/mint-format.git",
"directory": "packages/cli"
},
"license": "MIT",
diff --git a/packages/mint/package.json b/packages/mint/package.json
index d316032..7b12566 100644
--- a/packages/mint/package.json
+++ b/packages/mint/package.json
@@ -13,10 +13,10 @@
"decoder",
"minimal"
],
- "homepage": "https://github.com/q1k-oss/mint",
+ "homepage": "https://github.com/q1k-oss/mint-format#readme",
"repository": {
"type": "git",
- "url": "git+https://github.com/q1k-oss/mint.git",
+ "url": "git+https://github.com/q1k-oss/mint-format.git",
"directory": "packages/mint"
},
"license": "MIT",