From b177dd8192b1734a18f0195332e0fa69b58af606 Mon Sep 17 00:00:00 2001 From: Ali Mihandoost Date: Tue, 24 Sep 2024 19:57:12 +0330 Subject: [PATCH] docs: fix readme issues --- .vscode/settings.json | 1 + README.md | 16 ++++++++-------- packages/context/README.md | 2 +- packages/fetch-state-machine/README.md | 2 +- packages/flux/README.md | 21 ++++++++++++++++++--- packages/flux/package.json | 2 +- packages/fsm/README.md | 2 +- packages/observable/README.md | 2 +- packages/remote-context/README.md | 2 +- packages/signal/README.md | 2 +- 10 files changed, 34 insertions(+), 18 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index d0d3fbb3..3e5d007b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -46,6 +46,7 @@ "cSpell.words": [ "Alwatr", "conventionalcommits", + "Exir", "jfsm", "Mihandoost", "tsbuildinfo" diff --git a/README.md b/README.md index 9fb6c92e..980428f1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Alwatr Flux - Elegant State Management and Event System +# Flux - Elegant State Management and Event System ## Introduction -Alwatr Flux empowers your applications with elegant and powerful state management and event handling capabilities. Built on the observable design pattern, Flux provides a lightweight yet robust foundation for managing global signals and states. +Flux empowers your applications with elegant and powerful state management and event handling capabilities. Built on the observable design pattern, Flux provides a lightweight yet robust foundation for managing global signals and states. **Key Features:** @@ -16,15 +16,15 @@ Alwatr Flux empowers your applications with elegant and powerful state managemen ### Core Packages -- **@alwatr/observable:** Provides the core observable pattern implementation used throughout the Alwatr Flux ecosystem. See [packages/observable](packages/observable) for more details. -- **@alwatr/context:** A simple yet powerful TypeScript library for managing application context and facilitating efficient communication between components. See [packages/context](packages/context) for more details. -- **@alwatr/signal:** A lightweight library for managing global signals and state changes. See [packages/signal](packages/signal) for more details. +- **Observable:** Provides the core observable pattern implementation used throughout the Flux ecosystem. See [packages/observable](packages/observable) for more details. +- **Context:** A simple yet powerful TypeScript library for managing application context and facilitating efficient communication between components. See [packages/context](packages/context) for more details. +- **Signal:** A lightweight library for managing global signals and state changes. See [packages/signal](packages/signal) for more details. ### State Machines -- **@alwatr/fsm:** Core finite-state machine implementation. See [packages/fsm](packages/fsm) for more details. -- **@alwatr/fetch-state-machine:** Simplifies state management for server requests with built-in support for fetch operations. See [packages/fetch-state-machine](packages/fetch-state-machine) for more details. -- **@alwatr/remote-context:** Manages remote context data with offline-first support and automatic revalidation. See [packages/remote-context](packages/remote-context) for more details. +- **FSM:** Core finite-state machine implementation. See [packages/fsm](packages/fsm) for more details. +- **FetchStateMachine:** Simplifies state management for server requests with built-in support for fetch operations. See [packages/fetch-state-machine](packages/fetch-state-machine) for more details. +- **RemoteContext:** Manages remote context data with offline-first support and automatic revalidation. See [packages/remote-context](packages/remote-context) for more details. ## Usage diff --git a/packages/context/README.md b/packages/context/README.md index 0616cc74..2110dae6 100644 --- a/packages/context/README.md +++ b/packages/context/README.md @@ -1,4 +1,4 @@ -# @alwatr/context +# Flux: Context A simple yet powerful TypeScript library for managing application context and facilitating efficient communication between components. diff --git a/packages/fetch-state-machine/README.md b/packages/fetch-state-machine/README.md index 3aa223c1..438662fc 100644 --- a/packages/fetch-state-machine/README.md +++ b/packages/fetch-state-machine/README.md @@ -1,4 +1,4 @@ -# @alwatr/fetch-state-machine +# Flux: Fetch State Machine A powerful TypeScript library for managing asynchronous fetch requests with a built-in state machine. diff --git a/packages/flux/README.md b/packages/flux/README.md index 5b7318dc..980428f1 100644 --- a/packages/flux/README.md +++ b/packages/flux/README.md @@ -1,15 +1,30 @@ -# Alwatr Flux - Elegant State Management and Event System +# Flux - Elegant State Management and Event System ## Introduction -Alwatr Flux empowers your applications with elegant and powerful state management and event handling capabilities. Built on the observable design pattern, Flux provides a lightweight yet robust foundation for managing global signals and states. +Flux empowers your applications with elegant and powerful state management and event handling capabilities. Built on the observable design pattern, Flux provides a lightweight yet robust foundation for managing global signals and states. **Key Features:** - **Intuitive State Management:** Embrace Flux as an advanced alternative to Redux or Recoil, minus the complexities and unnecessary overhead. Each signal maintains its own value, offering seamless state control. - **Finite-State Machines (FSM):** Leverage observables to gracefully manage invocations and state transitions within your finite-state machines. - **Server Context Management:** Effortlessly handle server-side context with Flux's elegant context manager, ensuring optimal organization and control. -- ... +- **Remote Context Management:** Manage remote context data with offline-first support and automatic revalidation. +- **Fetch State Machine:** Simplify state management for server requests with built-in support for fetch operations. + +## Packages + +### Core Packages + +- **Observable:** Provides the core observable pattern implementation used throughout the Flux ecosystem. See [packages/observable](packages/observable) for more details. +- **Context:** A simple yet powerful TypeScript library for managing application context and facilitating efficient communication between components. See [packages/context](packages/context) for more details. +- **Signal:** A lightweight library for managing global signals and state changes. See [packages/signal](packages/signal) for more details. + +### State Machines + +- **FSM:** Core finite-state machine implementation. See [packages/fsm](packages/fsm) for more details. +- **FetchStateMachine:** Simplifies state management for server requests with built-in support for fetch operations. See [packages/fetch-state-machine](packages/fetch-state-machine) for more details. +- **RemoteContext:** Manages remote context data with offline-first support and automatic revalidation. See [packages/remote-context](packages/remote-context) for more details. ## Usage diff --git a/packages/flux/package.json b/packages/flux/package.json index 60fb335d..ca3328f4 100644 --- a/packages/flux/package.json +++ b/packages/flux/package.json @@ -1,7 +1,7 @@ { "name": "@alwatr/flux", "version": "3.0.2", - "description": "Alwatr Flux empowers your applications with elegant and powerful state management and event handling capabilities. Built on the observable design pattern, Flux provides a lightweight yet robust foundation for managing global signals and states.", + "description": "Flux empowers your applications with elegant and powerful state management and event handling capabilities. Built on the observable design pattern, Flux provides a lightweight yet robust foundation for managing global signals and states.", "author": "S. Ali Mihandoost ", "keywords": [ "signal", diff --git a/packages/fsm/README.md b/packages/fsm/README.md index ab3eb780..9a22c35d 100644 --- a/packages/fsm/README.md +++ b/packages/fsm/README.md @@ -1,4 +1,4 @@ -# @alwatr/fsm +# Flux: Finite State Machine A robust TypeScript library for implementing Flux (Finite) State Machines, enabling clear and organized management of application state and transitions. diff --git a/packages/observable/README.md b/packages/observable/README.md index 5811a45b..45d6b8ed 100644 --- a/packages/observable/README.md +++ b/packages/observable/README.md @@ -1,4 +1,4 @@ -# @alwatr/observable +# Flux: Observable A lightweight and flexible TypeScript library for implementing the observer pattern (similar to signals) with events, subscriptions, and convenient features. diff --git a/packages/remote-context/README.md b/packages/remote-context/README.md index 3a7725ab..5b21ad15 100644 --- a/packages/remote-context/README.md +++ b/packages/remote-context/README.md @@ -1,4 +1,4 @@ -# @alwatr/remote-context +# Flux: Remote Context A powerful TypeScript library for managing remote context data with offline-first support and automatic revalidation. diff --git a/packages/signal/README.md b/packages/signal/README.md index b0798385..54223437 100644 --- a/packages/signal/README.md +++ b/packages/signal/README.md @@ -1,4 +1,4 @@ -# @alwatr/signal +# Flux: Signal A simple and efficient TypeScript library for event-driven communication using signals.