@hotmeshio/hotmesh 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -36
- package/build/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,8 +9,8 @@ npm install @hotmeshio/hotmesh
|
|
|
9
9
|
```
|
|
10
10
|
You have a Redis instance? Good. You're ready to go.
|
|
11
11
|
|
|
12
|
-
##
|
|
13
|
-
[
|
|
12
|
+
## Learn
|
|
13
|
+
[SDK Docs](https://hotmeshio.github.io/sdk-typescript/) | [Samples](https://github.com/hotmeshio/samples-typescript) | [Intro Video](https://www.loom.com/share/211bd4b4038d42f0ba34374ef5b6f961?sid=7b889a56-f60f-4ccc-84e7-8c2697e548a9)
|
|
14
14
|
|
|
15
15
|
## MeshCall | Connect Everything
|
|
16
16
|
[MeshCall](https://hotmeshio.github.io/sdk-typescript/classes/services_meshcall.MeshCall.html) connects your functions to the Redis-backed mesh, exposing them as idempotent endpoints. Function responses are cacheable and functions can even run as idempotent cron jobs. Make blazing fast interservice calls that return in milliseconds without the overhead of HTTP.
|
|
@@ -694,9 +694,7 @@ HotMesh's telemetry output provides unmatched insight into long-running, multi-s
|
|
|
694
694
|
<img src="./docs/img/visualize/opentelemetry.png" alt="Open Telemetry" style="width:600px;max-width:600px;">
|
|
695
695
|
|
|
696
696
|
## Visualize | HotMesh Dashboard
|
|
697
|
-
The HotMesh dashboard provides a detailed overview of all running workflows.
|
|
698
|
-
|
|
699
|
-
An LLM is included to simplify querying and analyzing workflow data for those deployments that include the Redis `FT.SEARCH` module.
|
|
697
|
+
The HotMesh dashboard provides a detailed overview of all running workflows. An LLM is included to simplify querying and analyzing workflow data for those deployments that include the Redis `FT.SEARCH` module.
|
|
700
698
|
|
|
701
699
|
<img src="./docs/img/visualize/hotmesh_dashboard.png" alt="HotMesh Dashboard" style="width:600px;max-width:600px;">
|
|
702
700
|
|
|
@@ -705,35 +703,8 @@ View commands, streams, data, CPU, load, etc using the RedisInsight data browser
|
|
|
705
703
|
|
|
706
704
|
<img src="./docs/img/visualize/redisinsight.png" alt="Redis Insight" style="width:600px;max-width:600px;">
|
|
707
705
|
|
|
708
|
-
##
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
### FAQ
|
|
712
|
-
Refer to the [FAQ](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/faq.md) for terminology, definitions, and an exploration of how HotMesh facilitates orchestration use cases.
|
|
713
|
-
|
|
714
|
-
### Quick Start
|
|
715
|
-
Refer to the [Quick Start](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/quickstart.md) for sample YAML workflows you can copy, paste, and modify to get started with HotMesh.
|
|
716
|
-
|
|
717
|
-
### Developer Guide
|
|
718
|
-
For more details on the complete development process, including information about schemas, APIs, and deployment, consult the [Developer Guide](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/developer_guide.md).
|
|
719
|
-
|
|
720
|
-
### Model Driven Development
|
|
721
|
-
[Model Driven Development](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/model_driven_development.md) is an established strategy for managing process-oriented tasks. Check out this guide to understand its foundational principles.
|
|
722
|
-
|
|
723
|
-
### Data Mapping
|
|
724
|
-
Exchanging data between activities is central to HotMesh. For detailed information on supported functions and the functional mapping syntax (@pipes), see the [Data Mapping Overview](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/data_mapping.md).
|
|
725
|
-
|
|
726
|
-
### Composition
|
|
727
|
-
While the simplest graphs are linear, detailing a consistent sequence of non-cyclical activities, graphs can be layered to represent intricate business scenarios. Some can even be designed to accommodate long-lasting workflows that span months. For more details, check out the [Composable Workflow Guide](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/composable_workflow.md).
|
|
728
|
-
|
|
729
|
-
### System Lifecycle
|
|
730
|
-
Gain insight into HotMesh's monitoring, exception handling, and alarm configurations via the [System Lifecycle Guide](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/system_lifecycle.md).
|
|
731
|
-
|
|
732
|
-
### Distributed Orchestration | System Overview
|
|
733
|
-
HotMesh is a distributed orchestration engine. Refer to the [Distributed Orchestration Guide](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/distributed_orchestration.md) for a high-level overview of the approach.
|
|
734
|
-
|
|
735
|
-
### Distributed Orchestration | System Design
|
|
736
|
-
HotMesh is more than Redis and TypeScript. The theory that underlies the architecture is applicable to any number of data storage and streaming backends: [A Message-Oriented Approach to Decentralized Process Orchestration](https://zenodo.org/records/12168558).
|
|
706
|
+
## Samples
|
|
707
|
+
Refer to the [hotmeshio/samples-typescript](https://github.com/hotmeshio/samples-typescript) Git repo for *tutorials* and instructions on deploying the *HotMesh Dashboard*.
|
|
737
708
|
|
|
738
|
-
|
|
739
|
-
|
|
709
|
+
## Advanced
|
|
710
|
+
For more advanced topics, including details on the underlying modeling and design system (HotMesh) refer to the [Advanced README](https://github.com/hotmeshio/sdk-typescript/tree/main/docs/advanced.md).
|
package/build/package.json
CHANGED