Skip to content

Commit 7a2c943

Browse files
committed
docs: update readme + changelog + up version
1 parent 89c0bce commit 7a2c943

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.3.1] - 2025-12-04
9+
10+
### Changed
11+
- **DX Improvement:** Exposed main classes (`MemoryStore`, `Fact`, `Operation`, etc.) directly in the top-level package.
12+
- Now you can use: `from memstate import MemoryStore` instead of importing from submodules.
13+
- **Internal:** Switched to dynamic versioning (single source of truth in `pyproject.toml`).
14+
815
## [0.3.0] - 2025-12-03
916

1017
### Added

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,7 @@ pip install memstate[redis]
8585
### 1. Basic Usage (Structured Memory)
8686

8787
```python
88-
from memstate.storage import MemoryStore, Constraint
89-
from memstate.schemas import Fact
90-
from memstate.backends.sqlite import SQLiteStorage
88+
from memstate import MemoryStore, Constraint, Fact, SQLiteStorage
9189
from pydantic import BaseModel
9290

9391
# 1. Define schema
@@ -183,9 +181,10 @@ app = workflow.compile(checkpointer=checkpointer)
183181

184182
Check the [examples/](https://github.com/scream4ik/MemState/tree/main/examples) folder:
185183

186-
* **[examples/rag_hook_demo.py](https://github.com/scream4ik/MemState/blob/main/examples/rag_hook_demo.py)** - **See Chroma Sync in action.**
187-
* **[examples/main_demo.py](https://github.com/scream4ik/MemState/blob/main/examples/main_demo.py)** - Full tour of schemas and rollbacks.
188-
* **[examples/langgraph_checkpoint_demo.py](https://github.com/scream4ik/MemState/blob/main/examples/langgraph_checkpoint_demo.py)** - LangGraph persistence without API keys.
184+
* **[examples/main_demo.py](https://github.com/scream4ik/MemState/blob/main/examples/main_demo.py)** - Full tour: Schemas, Singletons, Hallucination Correction via Rollback.
185+
* **[examples/rag_hook_demo.py](https://github.com/scream4ik/MemState/blob/main/examples/rag_hook_demo.py)** - Shows how to use MemState as the "Master DB" that automatically syncs text to a mock Vector DB for RAG.
186+
* **[examples/langgraph_checkpoint_demo.py](https://github.com/scream4ik/MemState/blob/main/examples/langgraph_checkpoint_demo.py)** - Shows how to plug `MemStateCheckpointer` into a LangGraph workflow.
187+
* **[examples/pizza_agent_demo.py](https://github.com/scream4ik/MemState/blob/main/examples/pizza_agent_demo.py)** - A "Pizza Ordering" agent that separates Chat History from Business State (the JSON order).
189188

190189
---
191190

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "memstate"
3-
version = "0.3.0"
3+
version = "0.3.1"
44
description = "ACID-like memory for Agents. Atomically syncs Pydantic models & Vector DBs with Git-style versioning."
55
readme = "README.md"
66
requires-python = ">=3.10"

0 commit comments

Comments
 (0)