Skip to content

Updating the documentation to say "use ^0.1.6" #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joanise merged 2 commits into from
Nov 4, 2022
Merged

Updating the documentation to say "use ^0.1.6" #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bff9167
fix: peg web-component version to ^0.1.6 in the documentation
joanise Nov 4, 2022
c4bab34
docs: the top-level README should point to the individual components
joanise Nov 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ Interactive story telling embeddable into any website!

<!-- TODO: put an animated GIF here, showing it off! -->

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
---------------

Expand Down
4 changes: 2 additions & 2 deletions packages/stencil-component/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions packages/stencil-component/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<script type="module" src="https://unpkg.com/@roedoejet/readalong/dist/read-along/read-along.esm.js"></script>
<script nomodule src="https://unpkg.com/@roedoejet/readalong/dist/read-along/read-along.js"></script>
<script type="module" src="https://unpkg.com/@roedoejet/readalong@^0.1.6/dist/read-along/read-along.esm.js"></script>
<script nomodule src="https://unpkg.com/@roedoejet/readalong@^0.1.6/dist/read-along/read-along.js"></script>
```

Then, you can add as many read-along components to your page as you like simply by adding `<read-along></read-along>`
Expand All @@ -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

Expand Down