From 376b2dfd75653825c58985b1dedb815a62894631 Mon Sep 17 00:00:00 2001 From: Ali Ibrahim Jr <48456829+IBJunior@users.noreply.github.com> Date: Thu, 4 Sep 2025 12:52:02 +0200 Subject: [PATCH 1/2] docs(readme): link examples using absolute GitHub URLs for npm; bump version to 2.1.1; update CHANGELOG --- CHANGELOG.md | 6 ++++++ README.md | 14 ++++++++------ package.json | 2 +- 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6db9fae..6a2398a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. +## [2.1.1] - 2025-09-04 + +### Fixed + +- README: converted example links to absolute GitHub URLs so they render correctly on npmjs.com. + ## [2.1.0] - 2025-08-28 ### Breaking diff --git a/README.md b/README.md index 8eb13ad..99062bd 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,11 @@ Lightweight, model-agnostic chat history compression utilities for AI assistants ![CI](https://github.com/agentailor/slimcontext/actions/workflows/ci.yml/badge.svg) + ## Examples -- OpenAI: see `examples/OPENAI_EXAMPLE.md` (copy-paste snippet; BYOM, no deps added here). -- LangChain: see `examples/LANGCHAIN_EXAMPLE.md` and `examples/LANGCHAIN_COMPRESS_HISTORY.md`. +- OpenAI: see [examples/OPENAI_EXAMPLE.md](https://github.com/agentailor/slimcontext/blob/main/examples/OPENAI_EXAMPLE.md) (copy-paste snippet; BYOM, no deps added here). +- LangChain: see [examples/LANGCHAIN_EXAMPLE.md](https://github.com/agentailor/slimcontext/blob/main/examples/LANGCHAIN_EXAMPLE.md) and [examples/LANGCHAIN_COMPRESS_HISTORY.md](https://github.com/agentailor/slimcontext/blob/main/examples/LANGCHAIN_COMPRESS_HISTORY.md). ## Features @@ -125,11 +126,12 @@ Notes about summarization behavior You can chain strategies depending on token thresholds or other heuristics. + ## Example Integration -- See `examples/OPENAI_EXAMPLE.md` for an OpenAI copy-paste snippet. -- See `examples/LANGCHAIN_EXAMPLE.md` for a LangChain-style integration. -- See `examples/LANGCHAIN_COMPRESS_HISTORY.md` for a one-call LangChain history compression helper. +- See [examples/OPENAI_EXAMPLE.md](https://github.com/agentailor/slimcontext/blob/main/examples/OPENAI_EXAMPLE.md) for an OpenAI copy-paste snippet. +- See [examples/LANGCHAIN_EXAMPLE.md](https://github.com/agentailor/slimcontext/blob/main/examples/LANGCHAIN_EXAMPLE.md) for a LangChain-style integration. +- See [examples/LANGCHAIN_COMPRESS_HISTORY.md](https://github.com/agentailor/slimcontext/blob/main/examples/LANGCHAIN_COMPRESS_HISTORY.md) for a one-call LangChain history compression helper. ## Adapters @@ -170,7 +172,7 @@ const compact = await langchain.compressLangChainHistory(history, { }); ``` -See `examples/LANGCHAIN_COMPRESS_HISTORY.md` for a fuller copy-paste example. +See [examples/LANGCHAIN_COMPRESS_HISTORY.md](https://github.com/agentailor/slimcontext/blob/main/examples/LANGCHAIN_COMPRESS_HISTORY.md) for a fuller copy-paste example. ## API diff --git a/package.json b/package.json index ca575a4..71fa999 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "slimcontext", - "version": "2.1.0", + "version": "2.1.1", "description": "Lightweight, model-agnostic chat history compression (trim + summarize) for AI assistants.", "main": "dist/index.js", "types": "dist/index.d.ts", From 1e7dd61e557e126e0f0de76106c4eac3ca4cf693 Mon Sep 17 00:00:00 2001 From: Ali Ibrahim Jr <48456829+IBJunior@users.noreply.github.com> Date: Thu, 4 Sep 2025 12:55:01 +0200 Subject: [PATCH 2/2] fix: fixed prettier --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 99062bd..3fd8a91 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ Lightweight, model-agnostic chat history compression utilities for AI assistants ![CI](https://github.com/agentailor/slimcontext/actions/workflows/ci.yml/badge.svg) - ## Examples - OpenAI: see [examples/OPENAI_EXAMPLE.md](https://github.com/agentailor/slimcontext/blob/main/examples/OPENAI_EXAMPLE.md) (copy-paste snippet; BYOM, no deps added here). @@ -126,7 +125,6 @@ Notes about summarization behavior You can chain strategies depending on token thresholds or other heuristics. - ## Example Integration - See [examples/OPENAI_EXAMPLE.md](https://github.com/agentailor/slimcontext/blob/main/examples/OPENAI_EXAMPLE.md) for an OpenAI copy-paste snippet.