readme

djang0dev · Dec 18, 2024 · ca3d5f3 · ca3d5f3
1 parent 8ace430
commit ca3d5f3
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# Special Resource Picker# special-shopify-resource-picker
+# Shopify Special Resource Picker
+
+A Polaris resource picker which can handle any resources intended to explain the usage of the Finite State Machines and the Actor Model using XState
+
+![Ui](https://djang0.dev/wp-content/uploads/2024/12/ui.gif)
+
+You can check [the live demo](https://djang0dev.github.io/special-shopify-resource-picker/)
+
+
+##  Logic
+
+We use the Actor Model for responsibility delegation:
+
+![Actor Model Logic](https://djang0.dev/wp-content/uploads/2024/12/demo-gif.gif)
diff --git a/eslint.config.js b/eslint.config.js
diff --git a/index.html b/index.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8" />
     <link rel="icon" type="image/svg+xml" href="/vite.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite + React + TS</title>
+    <title>Special Shopify Resource Picker</title>
   </head>
   <body>
     <div id="root"></div>