@pod-os/elements 0.1.1 → 0.1.2-78cc870.0

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +35 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pod-os/elements",
3
- "version": "0.1.1",
3
+ "version": "0.1.2-78cc870.0",
4
4
  "description": "Stencil Component Starter",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/custom-elements/index.js",
package/readme.md CHANGED
@@ -4,6 +4,41 @@
4
4
 
5
5
  HTML custom elements (aka web components) for PodOS.
6
6
 
7
+ **Using data from Solid Pods as easy as writing HTML!**
8
+
9
+ ## Quick Start
10
+
11
+ 1. Create a plain old html file
12
+ 2. Add latest PodOS script tag and stylesheet to the `head`
13
+ 3. Add a `<pos-app></pos-app>` to the `body` and use any PodOS element within it.
14
+ 4. Host the page on any webserver (like your Solid Pod 😉)
15
+
16
+ Try this 🤩:
17
+
18
+ ```html
19
+ <!doctype html>
20
+ <html>
21
+ <head>
22
+ <title>PodOS Quick Start</title>
23
+ <script type="module" src="https://unpkg.com/@pod-os/elements/dist/elements/elements.esm.js"></script>
24
+ <link href="https://unpkg.com/@pod-os/elements/dist/elements/elements.css" rel="stylesheet">
25
+ </head>
26
+ <body>
27
+ <pos-app>
28
+ <ion-content> <!-- PodOS elements are build on Ionic -->
29
+ <pos-resource uri="https://solidproject.solidcommunity.net/profile/card#me">
30
+ <h1>
31
+ <pos-label/>
32
+ </h1>
33
+ <blockquote>
34
+ <pos-description/>
35
+ </blockquote>
36
+ </pos-resource>
37
+ </ion-content>
38
+ </pos-app>
39
+ </body>
40
+ </html>
41
+ ```
7
42
 
8
43
  ## Development
9
44