forked from ryyst/kalzu-value-store
ryyst
8d6a280441
- Add conditional route registration based on feature toggles - AuthEnabled now controls authentication/user management endpoints - ClusteringEnabled controls member and Merkle tree endpoints - RevisionHistoryEnabled controls history endpoints - Feature toggles for RateLimitingEnabled and TamperLoggingEnabled were already implemented This completes issue #6 allowing flexible deployment scenarios by disabling unnecessary features and their associated endpoints. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
65 lines
2.3 KiB
Markdown
65 lines
2.3 KiB
Markdown
# Issue #2: Update README.md
|
|
|
|
**Status:** ✅ **COMPLETED** *(updated during this session)*
|
|
**Author:** MrKalzu
|
|
**Created:** 2025-09-12 22:01:34 +03:00
|
|
**Repository:** https://git.rauhala.info/ryyst/kalzu-value-store/issues/2
|
|
|
|
## Description
|
|
|
|
"It feels like the readme has lot of expired info after the latest update."
|
|
|
|
## Problem
|
|
|
|
The project's README file contained outdated information that needed to be revised following recent updates and refactoring.
|
|
|
|
## Resolution Status
|
|
|
|
**✅ COMPLETED** - The README.md has been comprehensively updated to reflect the current state of the codebase.
|
|
|
|
## Updates Made
|
|
|
|
### Architecture & Features
|
|
- ✅ Updated key features to include Merkle Tree sync, JWT authentication, and modular architecture
|
|
- ✅ Revised architecture diagram to show modular components
|
|
- ✅ Added authentication and authorization sections
|
|
- ✅ Updated conflict resolution description
|
|
|
|
### Configuration
|
|
- ✅ Added comprehensive configuration options including feature toggles
|
|
- ✅ Updated default values to match actual implementation
|
|
- ✅ Added feature toggle documentation (auth, clustering, compression, etc.)
|
|
- ✅ Included backup and tamper logging configuration
|
|
|
|
### API Documentation
|
|
- ✅ Added JWT authentication examples
|
|
- ✅ Updated API endpoints with proper authorization headers
|
|
- ✅ Added authentication endpoints documentation
|
|
- ✅ Included Merkle tree and sync endpoints
|
|
|
|
### Project Structure
|
|
- ✅ Completely updated project structure to reflect modular architecture
|
|
- ✅ Documented all packages (auth/, cluster/, storage/, server/, etc.)
|
|
- ✅ Updated file organization to match current codebase
|
|
|
|
### Development & Testing
|
|
- ✅ Updated build and test commands
|
|
- ✅ Added integration test suite documentation
|
|
- ✅ Updated conflict resolution testing procedures
|
|
- ✅ Added code quality tools documentation
|
|
|
|
### Performance & Limitations
|
|
- ✅ Updated performance characteristics with Merkle sync improvements
|
|
- ✅ Revised limitations to reflect implemented features
|
|
- ✅ Added realistic timing expectations
|
|
|
|
## Current Status
|
|
|
|
The README.md now accurately reflects:
|
|
- Current modular architecture
|
|
- All implemented features and capabilities
|
|
- Proper configuration options
|
|
- Updated development workflow
|
|
- Comprehensive API documentation
|
|
|
|
**This issue has been resolved.** |