atomicdata-dev
diff --git a/‎.gitignore
Lines changed: 1 addition & 0 deletions b/‎.gitignore
Lines changed: 1 addition & 0 deletions
diff --git a/‎README.md
Lines changed: 23 additions & 1 deletion b/‎README.md
Lines changed: 23 additions & 1 deletion
diff --git a/‎index.html
Lines changed: 6 additions & 1 deletion b/‎index.html
Lines changed: 6 additions & 1 deletion
diff --git a/‎package.json
Lines changed: 7 additions & 4 deletions b/‎package.json
Lines changed: 7 additions & 4 deletions
@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 dist
 dist-ssr
+dev-dist
 *.local
 
 # Editor directories and files
 
@@ -1 +1,23 @@
-# A simple and intuitive way to create Atomic Data models
+# Atomic Data Model Builder
+AD Model Builder lets you build Atomic Data classes in an intuitive way.
+
+The app was build to explore what would be needed to make an @tomic/react style package for Svelte but turned out to be useful enough to warrant it's own repository.
+
+You can find it here: https://atomicdata-dev.github.io/atomic-data-model-builder/
+
+<img width="1491" alt="image" src="https://user-images.githubusercontent.com/8804875/208479185-800f9f0d-056b-416f-9fac-cff093cc2b40.png">
+
+## Running locally
+Clone the repo to a folder and navigate to the folder.
+
+Install the dependencies:
+```
+pnpm install
+```
+
+Start the vite dev server:
+```
+pnpm run dev
+```
+
+Once the vite dev server is running you can navigate to `http://localhost:5174/atomic-data-model-builder/`
@@ -2,7 +2,12 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta content="A fast, easy and intuitive tool to create Atomic Data models" name="description" />
+    <link href="/icon.png" rel="icon" type="image/png" />
+    <link href="/apple-touch-icon.png" rel="apple-touch-icon" sizes="180x180" />
+    <link href="/favicon-32x32.png" rel="icon" sizes="32x32" type="image/png" />
+    <link href="/favicon-16x16.png" rel="icon" sizes="16x16" type="image/png" />
+    <link color="#1e43a3" href="/mask-icon.svg" rel="mask-icon" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>AD Model Builder</title>
   </head>
 
@@ -1,29 +1,32 @@
 {
   "name": "ad-model-builder",
   "private": true,
-  "version": "0.0.1",
+  "version": "1.0.0",
   "type": "module",
   "scripts": {
     "dev": "vite",
     "build": "vite build",
     "preview": "vite preview",
-    "check": "svelte-check --tsconfig ./tsconfig.json"
+    "check": "svelte-check --tsconfig ./tsconfig.json",
+    "deploy": "gh-pages -d dist"
   },
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "^2.0.0",
     "@tsconfig/svelte": "^3.0.0",
+    "gh-pages": "^4.0.0",
     "highlight.js": "^11.7.0",
     "svelte": "^3.54.0",
     "svelte-check": "^2.10.0",
     "svelte-highlight": "^6.2.1",
     "tslib": "^2.4.1",
     "typescript": "^4.9.3",
-    "vite": "^4.0.0"
+    "vite": "^4.0.0",
+    "vite-plugin-pwa": "^0.14.0"
   },
   "dependencies": {
     "@tomic/lib": "^0.34.0",
     "open-props": "^1.5.1",
     "svelte-icon": "^1.3.0",
-    "svelte-select": "5.0.0-beta.40"
+    "svelte-select": "^5.0.0"
   }
 }