state-ref@2.1.0

state-ref v2.1.0

📚 Documentation

This release focuses on comprehensive documentation and developer experience improvements.

New Documentation Site

A complete documentation website built with Lithent and Tailwind CSS:

• Interactive code examples with syntax highlighting
• Bilingual support (English/Korean)
• Modern, responsive UI design
• Organized navigation with comprehensive guides

Documentation Coverage

Core Concepts

• Quick Start guide
• Store creation (createStore, createStoreManualSync)
• Watch function and subscription patterns
• StateRefStore reference types
• Working with primitive values

Advanced Features

• Manual synchronization patterns
• Lens-based immutable updates
• copyable() helper for deep cloning
• cloneDeep() utilities
• createComputed() for computed values
• combineWatch() for multiple subscriptions

Framework Integration

• React (@stateref/connect-react)
• Preact (@stateref/connect-preact)
• Vue 3 (@stateref/connect-vue)
• Svelte (@stateref/connect-svelte)
• Solid.js (@stateref/connect-solid)
• Lithent (native support)
• Custom connector implementation guide

API Reference

• Complete type definitions
• Core API documentation
• Helper functions reference

🤖 AI Agent Support

Added structured documentation for AI coding assistants:

• Skills documentation in skills/state-ref/ directory
• Common mistakes and patterns to avoid
• Core rules and best practices
• Quick reference examples
• Framework connector patterns
• Troubleshooting guide
• Agent addon integration guide

✨ Improvements

• Added official StateRef logo and brand assets
• GitHub repository link in documentation header
• Enhanced README with clearer usage examples
• Better organized documentation structure

📦 Installation

npm install state-ref@2.1.0

🔗 Links

• Repository: https://github.com/superlucky84/state-ref
• npm: https://www.npmjs.com/package/state-ref
• Documentation: https://superlucky84.github.io/state-ref/