Welcome to Jiro.Shared
Jiro.Shared is a foundational library providing shared types, models, and utilities used across the Jiro ecosystem, including JiroCloud and Jiro instances. It ensures consistent communication contracts and type safety throughout the entire system.
🚀 Quick Start
Get started with Jiro.Shared in minutes:
- Documentation - Learn about shared types and models
- API Reference - Explore the complete API documentation
- Installation Guide - Setup and configuration guide
✨ Key Features
- 🔗 WebSocket Endpoints - Predefined endpoint constants for real-time communication
- 📡 gRPC Definitions - Protocol buffer definitions for efficient service communication
- � Shared Models - Common request and response data transfer objects (DTOs)
- �️ Type Safety - Strongly-typed contracts for reliable inter-service communication
- � Documentation - Full XML documentation for excellent IntelliSense support
📚 Documentation Sections
📖 Documentation
- Project overview and architecture
- Getting started guides
- Type definitions and usage
- Integration examples
- Changelog and version history
🔧 API Reference
- Complete .NET API documentation
- Class and interface references
- Method documentation with examples
- Generated from source code
🏗️ Architecture Overview
Jiro.Shared serves as the foundation for communication across the Jiro ecosystem:
- WebSocket Communication - Real-time messaging contracts and endpoint definitions
- gRPC Services - Efficient binary communication protocols
- Shared Models - Common data transfer objects used throughout the ecosystem
- Type Safety - Strongly-typed contracts ensuring reliable communication
🤝 Contributing
We welcome contributions! Please see our documentation for guidelines on how to contribute to the Jiro project.
Ready to dive in? Start with Documentation or explore the API Reference.