From 17ec304fecab6196134aed839a4f4e6ce09a0e18 Mon Sep 17 00:00:00 2001 From: Andrey Sobolev Date: Wed, 1 Oct 2025 11:51:59 +0700 Subject: [PATCH] Add getting starting diagram --- CHANGELOG.md | 3 +++ CONTRIBUTING.md | 12 ++++++------ README.md | 27 +++++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 66d0047a6b..ed1f0cc7aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ### Added + - Comprehensive documentation and examples - GitHub community health files (CONTRIBUTING.md, SECURITY.md) - Issue and PR templates @@ -15,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [0.7.9] - 2025-10-01 ### Added + - Initial public release - Core network implementation with distributed architecture - ZeroMQ-based RPC communication layer @@ -28,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Full documentation and examples ### Features + - Distributed load balancing across multiple agents - Container lifecycle management with reference counting - Event broadcasting capabilities diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be55766122..737e169e6f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -155,17 +155,17 @@ interface MyOptions { export class MyClass { // Private fields first private readonly config: MyOptions - + // Constructor constructor(options: MyOptions) { this.config = options } - + // Public methods async doSomething(): Promise { // Implementation } - + // Private methods private helper(): void { // Implementation @@ -205,14 +205,14 @@ describe('ComponentName', () => { it('should behave correctly under normal conditions', async () => { // Arrange const component = new ComponentName() - + // Act const result = await component.methodName() - + // Assert expect(result).toBe(expected) }) - + it('should handle error conditions', async () => { // Test error cases }) diff --git a/README.md b/README.md index c6085280cc..b85e45ad7b 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,33 @@ Build enterprise-grade distributed systems with automatic service discovery, hig [Features](#-why-build-your-product-on-huly-network) • [Quick Start](#-getting-started) • [Documentation](#-documentation) • [Examples](#-examples) • [API Reference](#-api-reference) • [Contributing](#-contributing) +```mermaid +flowchart TD + subgraph Learn["📚 STEP 1: Core Concepts"] + direction TB + Network["🌐 Network Server
Central hub, Port 3737
⚠️ Single instance only"] + Agent["🤖 Agent
Runs containers
✅ Multiple instances OK"] + Container["📦 Container
Your business logic
Implements interface"] + Client["💻 Client
Requests containers
Sends operations"] + end + + Learn --> Deploy + + subgraph Deploy["🚀 STEP 2: Production Features"] + direction TB + P1["⚡ High Availability
Multiple agents, auto-failover"] + P2["🎯 Multi-tenancy
Labels & routing"] + P3["📡 Event Broadcasting
Real-time updates"] + P4["📈 Scale & Monitor
Add agents, track health"] + end + + Deploy --> Success([🎉 Production Ready!]) + + style Success fill:#ffd700,stroke:#f57f17,stroke-width:3px + style Learn fill:#e3f2fd,stroke:#1976d2 + style Deploy fill:#e8f5e9,stroke:#388e3c +``` + ---