Skip to content

Commit 454b834

Browse files
committed
Update CHANGELOG, add Design Philosophy link to README, bump package-lock version
1 parent 9826c93 commit 454b834

File tree

3 files changed

+48
-73
lines changed

3 files changed

+48
-73
lines changed

CHANGELOG.md

Lines changed: 44 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,64 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
## [Unreleased]
99

1010
### Added
11+
- **Export/Import System**: Backup and restore memories across machines
12+
- `export-memory` command - Export memories to JSON with optional filtering
13+
- `import-memory` command - Import memories with duplicate detection
14+
- Supports tag filtering, date ranges, and limit parameters
15+
- Preserves timestamps and relationships
16+
- Dry-run mode for preview before import
17+
1118
- **Automated VS Code Setup**: One-command installation with automatic configuration
1219
- `npm run setup` command that handles install, build, link, and VS Code config
1320
- Automatic detection of VS Code stable and Insiders
1421
- Smart detection of `mcp.json` format (supports both `servers` and `mcpServers` properties)
1522
- Cross-platform support (Windows, macOS, Linux)
1623
- No manual configuration needed for VS Code users
1724

18-
- **Improved Build System**: Separated dev and release builds
19-
- `npm run build` - Fast development build (no version bump)
20-
- `npm run build:release` - Release build with automatic version bump
21-
- Prevents version spam during development
22-
- Cleaner version history
23-
2425
- **Time Range Search**: Filter memories by creation date
2526
- `daysAgo` parameter - Search memories from last N days (e.g., 7 for last week)
2627
- `startDate` parameter - Search memories created on or after a specific date
2728
- `endDate` parameter - Search memories created on or before a specific date
2829
- Works with content search, tag search, and combined queries
2930
- Supports both relative (daysAgo) and absolute (startDate/endDate) time filtering
3031

31-
- **Backup Statistics**: Memory stats now includes backup information when configured
32-
- Backup enabled status
33-
- Backup path location
34-
- Number of backup files
35-
- Minutes since last backup
36-
- Minutes until next backup
32+
- **Auto-Capture Mode**: LLM proactively stores important information
33+
- Enhanced tool descriptions guide LLM to capture preferences, decisions, and facts automatically
34+
- Stores silently without announcing to user
35+
- Proactive search at conversation start for context-aware responses
36+
- Real-world usage examples in documentation
37+
38+
- **Backup System**: Lazy backup with cloud storage compatibility
39+
- Optional automatic backups with configurable interval
40+
- Lazy backup strategy (only after write operations)
41+
- Throttled backups (respects minimum interval)
42+
- Cloud-safe mode for OneDrive/Dropbox (disables WAL)
43+
- Backup statistics in `memory-stats`
44+
45+
- **Relevance Filtering**: Precision control for search results
46+
- `minRelevance` parameter (0-1 scale) for filtering by BM25 score
47+
- High precision mode (0.7-0.9) for LLM context loading
48+
- Ranked results by relevance score
49+
- Useful for reducing noise in large memory sets
50+
51+
### Changed
52+
- **Improved Build System**: Separated dev and release builds
53+
- `npm run build` - Fast development build (no version bump)
54+
- `npm run build:release` - Release build with automatic version bump
55+
- Prevents version spam during development
3756

38-
- **Enhanced Documentation**: Comprehensive README improvements
39-
- Performance metrics table with throughput
40-
- Cloud storage best practices integrated
41-
- Clear installation options (npm vs development)
42-
- Backup configuration examples
43-
- Real-world usage examples
57+
- **Enhanced Documentation**:
58+
- Design Philosophy document explaining trade-offs and limitations
59+
- Performance benchmarks document with detailed analysis
60+
- Stress test suite with comprehensive README
61+
- Real-world usage examples for AI assistants
62+
- Cloud storage best practices integrated into main README
63+
64+
### Fixed
65+
- Full-text search now properly handles hyphenated terms
66+
- Fresh database initialization no longer creates unnecessary backups
67+
- Improved CLI argument parsing consistency across all commands
68+
- Better debug logging with hash formatting utilities
4469

4570
---
4671

@@ -50,7 +75,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5075
- Initial release
5176
- Basic memory storage with SQLite
5277
- Full-text search with FTS5
53-
- Tag-based filtering (comma-separated in single column)
78+
- Tag-based filtering
5479
- Command-line interface
5580
- MCP server implementation
5681
- Relationship support between memories
@@ -61,55 +86,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6186
- Delete by hash or tag
6287
- Memory statistics
6388
- Automatic relationship detection
64-
65-
---
66-
67-
## Migration Guide v1.x → v2.0
68-
69-
### Upgrading
70-
71-
No action required! Simply update to v2.0 and run as normal. The migration system will:
72-
73-
1. **Detect** old schema automatically
74-
2. **Create** backup of your database
75-
3. **Apply** migrations in a transaction
76-
4. **Verify** data integrity
77-
5. **Complete** in under 50ms
78-
79-
### What Changes
80-
81-
**User-Visible:**
82-
- ✅ Dramatically faster tag searches (50-200x)
83-
- ✅ Sub-millisecond operations across the board
84-
- ✅ Higher throughput (2,000-10,000 ops/sec)
85-
86-
**Under the Hood:**
87-
- ✅ Normalized tag storage
88-
- ✅ 7 new performance indexes
89-
- ✅ Updated FTS table schema
90-
- ✅ Transaction-based bulk operations
91-
- ✅ Optimized SQLite pragmas
92-
93-
**Your Code:**
94-
- ✅ No changes needed - 100% backward compatible
95-
- ✅ All APIs work exactly the same
96-
- ✅ No configuration changes required
97-
98-
### Rollback
99-
100-
If you need to rollback (unlikely):
101-
102-
1. Stop the server
103-
2. Find the backup file: `memory.db.backup-[timestamp]`
104-
3. Restore: `cp memory.db.backup-[timestamp] memory.db`
105-
4. Use v1.x version of the server
106-
107-
### Performance Expectations
108-
109-
After upgrading, expect:
110-
- Tag searches: 50-200x faster
111-
- Storage operations: 18-49x faster than targets
112-
- FTS searches: 714-1000x faster than targets
113-
- Bulk relationships: 10-50x faster
114-
115-
No configuration changes needed - performance improvements are automatic!

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ A blazingly fast Model Context Protocol (MCP) server for persistent memory stora
88

99
Perfect for AI assistants that need to remember context across conversations, store project notes, or build a personal knowledge base.
1010

11+
> 📚 **New to Simple Memory?** Read the [Design Philosophy](docs/DESIGN_PHILOSOPHY.md) to understand why it's built this way, the trade-offs made, and when this approach makes sense for your needs.
12+
1113
---
1214

1315
## ✨ Features

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)