Skip to content

docs: link examples for npm + bump to 2.1.1 #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IBJunior merged 2 commits into from
Sep 4, 2025
Merged

docs: link examples for npm + bump to 2.1.1 #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
376b2df
docs(readme): link examples using absolute GitHub URLs for npm; bump …
IBJunior Sep 4, 2025
1e7dd61
fix: fixed prettier
IBJunior Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Lightweight, model-agnostic chat history compression utilities for AI assistants

## 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

Expand Down Expand Up @@ -127,9 +127,9 @@ 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

Expand Down Expand Up @@ -170,7 +170,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

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down