Skip to content

Commit 05264ca

Browse files
authored
docs: Update README.md intro
1 parent 4d91e09 commit 05264ca

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,18 @@
99

1010
# Crystalize.js
1111

12-
The Crystalize.js library introduces a structured methodology for data management and transformations based on the concepts of "Crystals" and "Shards". In this library, a "Crystal" is an immutable representation of accumulated data or state, formed over time. Conversely, "Shards" are the individual units or operations that contribute to this accumulation. This design provides an analogy to a crystallization process where individual elements come together to form a solid structure. Example use cases include managing application states, time-series data analysis, event sourcing, state tracking in simulations, and modularized data transformations.
12+
The Crystalize.js library is your magic wand for data wizardry, introducing a methodology for data management: "Crystals" and their foundational building blocks, "Shards". Think of a "Crystal" as an iceberg, immutably capturing the essence of time and tales, representing a culmination of data or states. Imagine "Shards" as the droplets that over time, meld to craft these icebergs. Now imagine that you could turn back the clock, and see the formation of the iceberg at different points in its history.
1313

14-
It's like a reducer on steroids, but if reducers had undo/redo and time-travel.
14+
That is Crystalize.js. It's like a reducer on steroids, but if reducers had undo/redo and time-travel.
15+
16+
Here’s how you can use it to empower your projects:
17+
18+
1. 📚 Application State Manager: Using a Crystal as your application state, you get your normal state management, but with super-powers.
19+
2. 🕰️ Dynamic Time-based State: Turn your user into a time traveler, allowing them to explore the iceberg at any phase in its evolution, in anything from simple undo/redo, or a time-travel-based game.
20+
3. 🌊 Time-Series Data Analyzer: Just as maritime explorers chart the seas, use this tool to revisit and analyze the stages of your data’s growth at different points.
21+
4. 📝 Event Sourcing Recorder: Store the state changes triggered by events, not unlike the layers in an iceberg, to understand their influence on the overall structure.
22+
5. 🔍 Simulation State Monitor: Monitor the gradual shifts and changes, capturing every nuance as your data evolves and grows.
23+
6. 🛠️ Data Transformation Toolkit: Adjust and refine, much like sculpting the edges and facets to achieve the desired shape and structure.
1524

1625
## Table of contents
1726

0 commit comments

Comments
 (0)