@uoguelph/web-components 0.0.28 → 0.0.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,10 +3,29 @@
|
|
|
3
3
|
This is a collection of web components for use on various University of Guelph web pages. These components are
|
|
4
4
|
built using [Stencil](https://stenciljs.com/), a compiler which makes developing component libraries fast and simple.
|
|
5
5
|
|
|
6
|
-
##
|
|
6
|
+
## Including the components in a page
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
The best way to include the components in a page is to use [unpkg](https://www.unpkg.com), a fast and global CDN for everything on npm.
|
|
9
|
+
|
|
10
|
+
Put the following in the head of your HTML to always load the latest version
|
|
11
|
+
|
|
12
|
+
```html
|
|
13
|
+
<link
|
|
14
|
+
rel="stylesheet"
|
|
15
|
+
href="https://unpkg.com/@uoguelph/web-components/dist/uofg-web-components/uofg-web-components.css"
|
|
16
|
+
/>
|
|
17
|
+
<script
|
|
18
|
+
type="module"
|
|
19
|
+
src="https://unpkg.com/@uoguelph/web-components/dist/uofg-web-components/uofg-web-components.esm.js"
|
|
20
|
+
></script>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
If you want to load a specific version, follow the guide on [the unpkg website](https://www.unpkg.com).
|
|
9
24
|
|
|
10
25
|
## Using the components
|
|
11
26
|
|
|
12
27
|
[See the documentation for each component](/docs/components)
|
|
28
|
+
|
|
29
|
+
## Developing the components
|
|
30
|
+
|
|
31
|
+
[See the development guide](/development-guide.md)
|