joe-header 1.1.4 → 2.0.0-beta2

package/README.md

@@ -1,30 +1,24 @@
 ## Joe header
 
-Preact header application to be consumed on joejuice websites. Currently this is packaged and published to npm
+Web component to be consumed on joe and the juice websites. Currently this is packaged and published to npm.
 
 ## How to use
 
-After publishing to npm its possible to use unpkg to import the bundled widget. The package will look for a `.header` to attach itself to.
+After publishing to npm then it is possible to use unpkg to import the module.
 
 If a new version is available then use that version in the path, e.g. https://unpkg.com/joe-header@0.1.new-version/dist/joeheader.js
 
-Add this to index.html of the project where you want to use the header. 
+Add this to the index.html file of the project where you want to use the header.
 
 ```html
 <!-- index.html -->
 ...
 <body>
-  <div class="joe-web-header"></div>
-  <script async src="https://unpkg.com/joe-header/dist/joeheader.js"></script>
-	<!-- <script async src="https://unpkg.com/joe-header@0.1.70/dist/joeheader.js"></script> -->
-
-		<script>
-      // The component will init itsself but incase that it doesnt happen, try to wait for the dom to finish loading
-			window.addEventListener('DOMContentLoaded', (event) => {
-				joeheader.init();
-			});
-		</script>
-
+  <joe-header></joe-header>
+  <script
+    type="module"
+    src="https://unpkg.com/joe-header@2.0.0-beta1/dist/joe-header.js"
+  ></script>
 </body>
 ...
 ```
@@ -34,31 +28,29 @@ Add this to index.html of the project where you want to use the header.
 ALWAYS REMEMBER TO BUNBLDE FIRST
 
 ```bash
-# install dependencies
+# Install dependencies.
 yarn install
 
-# serve with hot reload at localhost:8080
+# Serve with hot reload at localhost.
 yarn dev
 
-# build npm ready bundles to be consumed by other Preact web apps. Builds to dist folder
-yarn bundle
+# Build npm ready bundles to be consumed by other web apps. Builds to dist folder.
+yarn build
 
-# usefull command to patch version number (x.x.x+1). Can also be done in package.json manually
-npm version patch 
+# Usefull command to patch version number (x.x.x+1). Can also be done in package.json manually.
+npm version patch
 
-# publish new bundle to npm. Build a new widget and increase version number in order to publish
+# Publish new build to npm. Build a new widget and increase version number in order to publish.
 npm publish
 ```
 
 ## Beta tags
 
-1. `yarn bundle`
+1. `yarn build`
 2. Modify version in package.json to the following format (match with existing verion numbers etc) `"version": "0.1.120-beta.1"` where beta.x is the number of those betas
 3. Publish to npm `npm publish --tag beta`
 
 There are two options for install:
-* Always install beta with `npm install packagename@beta`
-* Install specific version with `npm install package@0.1.120-beta.1`
-
 
-For detailed explanation on how things work, checkout the [CLI Readme](https://github.com/preactjs/preact-cli/blob/master/README.md).
+- Always install beta with `npm install packagename@beta`
+- Install specific version with `npm install package@0.1.120-beta.1`