build: added development notes and github pages

README.md

@@ -1,30 +1,18 @@
 ![medblocks ui logo](./public/medblocks-ui-medium.png)
 
 # Medblocks UI
-Web Components for rapid development of openEHR systems. Use any framework, just import the web components and use.
+Web Components for rapid development of openEHR systems. Read this blog post and watch this video to know more.
 
-# Configure your component here:
-Include the script from a CDN
-```
+# Development
+- This is a Svelte + Typescript project. It's a very easy framework to get started with if you know HTML, CSS and Javascript. 
+- Bulma is being used as the CSS framework. You can customize it at `src/css/main.scss`.
+- The `docgen.js` script automatically generate component customization values from JSDocs within `.svelte` files. The output is at `jsdocs.json`. The script is automatically run before `npm run build` and `npm run dev`.
 
+## Install
 ```
-or install using npm
-```sh
-npm install medblocks-ui
+npm install
 ```
-
-# Include it in your web app
-
-```html
-
-<medblocks-composition template={}/>
-<script></script>
-
-```
-
-
-# For developers
-This is a Svelte project. It's a very easy framework to get started with if you know HTML, CSS and Javascript. 
+## Start development server
 ```
 npm run dev
-```
+```

package.json

@@ -7,6 +7,8 @@
     "start": "sirv public",
     "test": "jest",
     "validate": "svelte-check",
+    "predeploy": "npm run build",
+    "pages": "gh-pages -d build",
     "deploy": "npm publish",
     "release": "standard-version"
   },
@@ -33,6 +35,7 @@
     "@types/node": "^14.14.7",
     "bulma": "^0.9.1",
     "doctrine": "^3.0.0",
+    "gh-pages": "^3.1.0",
     "htmlnano": "^0.2.8",
     "husky": "^4.3.8",
     "jest": "^26.6.1",