diff --git a/README.md b/README.md index 4dcfef1f..6607919e 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ Interactive story telling embeddable into any website! +This mono repo combines two components: + + - A [stencil web component](packages/stencil-component/) for visualizing read alongs, + - An [angular web component](packages/angular-workspace/) currently in development for editing them. + For maintainers --------------- diff --git a/packages/stencil-component/package-lock.json b/packages/stencil-component/package-lock.json index d8af3682..f279b5a3 100644 --- a/packages/stencil-component/package-lock.json +++ b/packages/stencil-component/package-lock.json @@ -1,12 +1,12 @@ { "name": "@roedoejet/readalong", - "version": "0.1.5", + "version": "0.1.6", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@roedoejet/readalong", - "version": "0.1.5", + "version": "0.1.6", "license": "MIT", "dependencies": { "howler": "^2.2.3", diff --git a/packages/stencil-component/readme.md b/packages/stencil-component/readme.md index d6fd199c..30ca935f 100644 --- a/packages/stencil-component/readme.md +++ b/packages/stencil-component/readme.md @@ -40,8 +40,8 @@ You can either modify the `/src/index.html` or after running `npm start` you can the following script import in your own `index.html` page: ```html - - + + ``` Then, you can add as many read-along components to your page as you like simply by adding `` @@ -56,7 +56,7 @@ using _________ service located here: ____________. ## Loading as a single file -By default, Stencil (the tool used to build this web component) uses lazy loading. However, some use cases for this web component might involve running the component as a single file, without access to the internet. A single-file script of this web component is therefore made available at https://unpkg.com/@roedoejet/readalong/dist/bundle.js although we recommend using the default imports using the unpkg content delivery network (cdn) described above. +By default, Stencil (the tool used to build this web component) uses lazy loading. However, some use cases for this web component might involve running the component as a single file, without access to the internet. A single-file script of this web component is therefore made available at https://unpkg.com/@roedoejet/readalong@^0.1.6/dist/bundle.js although we recommend using the default imports using the unpkg content delivery network (cdn) described above. ## Theming