@storecraft/dashboard 1.0.3 → 1.0.5

package/README.md

@@ -1,16 +1,23 @@
 # **Storecraft** Official Dashboard
-A `storecraft` dashboard, leveraging `static rendering` / `client side rendering` / `swr`,
-so it can be deployed into cost effective **CDN**.
 
-Effectively, two build targets:
-1. A website, with configurable backend endpoint
-2. A `library` with
+The Official `storecraft` Dashboard 🏆,
+- Leveraging `static rendering` / `client side rendering` / `swr`
+- Can be deployed into cost effective **CDN**
+- Also available at `jsDelivr` **CDN**
+
+Effectively, **TWO** Build Targets
+1. A `library` with
   - Dashboard as `react` functional component
   - a `mount` function, that you can wrap for any framework of pure DOM.
+2. A website, with configurable backend endpoint.
 
 Build is handled by `Vite`
 
 
+```bash
+npm i @storecraft/core
+```
+
 ## Development
 
 First, run the development server:
@@ -48,6 +55,45 @@ dist
 
 ```
 
+## Consuming via `React`
+
+First,
+
+```bash
+npm i @storecraft/dashboard
+```
+
+Then, 
+
+```jsx
+import { Dashboard } from '@storecraft/dashboard'
+
+export const Root = () => {
+
+  return (
+    <div className='w-screen h-screen'>
+      <Dashboard />
+    </div>
+  )
+} 
+
+```
+
+## Consuming via `jsDelivr`
+
+```html
+<script id='_storecraft_script_' type="module">
+  
+  import { mountStorecraftDashboard } from 'https://cdn.jsdelivr.net/npm/@storecraft/dashboard@latest/dist/lib/index.min.js';
+  
+  mountStorecraftDashboard(
+    document.getElementById('root'), false
+  );
+
+</script>
+
+```
+
 
 ```txt
 Author: Tomer Shalev