Skip to content

Commit

Permalink
docs: fix readme issues
Browse files Browse the repository at this point in the history
  • Loading branch information
alimd committed Sep 24, 2024
1 parent b7a5097 commit b177dd8
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 18 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
"cSpell.words": [
"Alwatr",
"conventionalcommits",
"Exir",
"jfsm",
"Mihandoost",
"tsbuildinfo"
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:**

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/context/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @alwatr/context
# Flux: Context

A simple yet powerful TypeScript library for managing application context and facilitating efficient communication between components.

Expand Down
2 changes: 1 addition & 1 deletion packages/fetch-state-machine/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
21 changes: 18 additions & 3 deletions packages/flux/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/flux/package.json
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>",
"keywords": [
"signal",
Expand Down
2 changes: 1 addition & 1 deletion packages/fsm/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion packages/observable/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion packages/remote-context/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion packages/signal/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @alwatr/signal
# Flux: Signal

A simple and efficient TypeScript library for event-driven communication using signals.

Expand Down

0 comments on commit b177dd8

Please sign in to comment.