@synthigy/tooling 0.1.0 → 0.1.1

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/README.md +39 -10
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,24 +2,54 @@
2
2
 
3
3
  Synthigy's browser tooling and portal binaries.
4
4
 
5
+ ## Install
6
+
7
+ **Portal CLI:**
8
+
9
+ ```sh
10
+ curl -fsSL https://raw.githubusercontent.com/synthigy/tooling/main/install.sh | sh
11
+ ```
12
+
13
+ ```powershell
14
+ irm https://raw.githubusercontent.com/synthigy/tooling/main/install.ps1 | iex
15
+ ```
16
+
17
+ **Web components**, straight from a CDN:
18
+
19
+ ```html
20
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@synthigy/tooling@0.1.1/dist/tooling.css">
21
+ <script src="https://cdn.jsdelivr.net/npm/@synthigy/tooling@0.1.1/dist/modeling.js"></script>
22
+
23
+ <synthigy-data-modeling endpoint="https://api.example.com" open></synthigy-data-modeling>
24
+ ```
25
+
26
+ or from npm:
27
+
28
+ ```sh
29
+ npm install @synthigy/tooling
30
+ ```
31
+
32
+ ## What's here
33
+
5
34
  - `dist/modeling.js` registers `<synthigy-data-modeling>`, `<synthigy-data-console>`
6
35
  and `<synthigy-log-cockpit>`.
7
36
  - `dist/tooling.css` is optional — the Inter font the components style
8
37
  themselves with. Every color token carries a fallback, so the elements
9
38
  render correctly without it.
10
- - GitHub Releases carry `synthigy-portal-{os}-{arch}` static binaries.
39
+ - GitHub Releases carry `synthigy-portal-{os}-{arch}` static binaries
40
+ (`install.sh`/`install.ps1` above fetch these automatically).
11
41
 
12
- ## Web components from a CDN
42
+ ## Web components
13
43
 
14
44
  ```html
15
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@synthigy/tooling@0.1.0/dist/tooling.css">
16
- <script src="https://cdn.jsdelivr.net/npm/@synthigy/tooling@0.1.0/dist/modeling.js"></script>
45
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@synthigy/tooling@0.1.1/dist/tooling.css">
46
+ <script src="https://cdn.jsdelivr.net/npm/@synthigy/tooling@0.1.1/dist/modeling.js"></script>
17
47
 
18
48
  <synthigy-data-modeling endpoint="https://api.example.com" open></synthigy-data-modeling>
19
49
  ```
20
50
 
21
51
  The same files are served straight from this repository's tags:
22
- `https://cdn.jsdelivr.net/gh/synthigy/tooling@v0.1.0/dist/modeling.js`.
52
+ `https://cdn.jsdelivr.net/gh/synthigy/tooling@v0.1.1/dist/modeling.js`.
23
53
 
24
54
  Attributes: `endpoint`, `open`. Properties: `tokenResolver`, `onClose`
25
55
  (`<synthigy-data-console>` also takes `entities`, `schema`). Events: `close`,
@@ -28,12 +58,11 @@ OIDC login against `endpoint`.
28
58
 
29
59
  ## Portal
30
60
 
31
- ```sh
32
- curl -fsSL https://raw.githubusercontent.com/synthigy/tooling/main/install.sh | sh
33
- ```
61
+ The installers above put a `synthigy` binary on your PATH (`~/.synthigy/bin`,
62
+ override with `SYNTHIGY_INSTALL_DIR`). Pin a version:
34
63
 
35
- ```powershell
36
- irm https://raw.githubusercontent.com/synthigy/tooling/main/install.ps1 | iex
64
+ ```sh
65
+ curl -fsSL https://raw.githubusercontent.com/synthigy/tooling/main/install.sh | sh -s -- v0.1.1
37
66
  ```
38
67
 
39
68
  Binaries and `sha256sums-portal.txt` are attached to each release here.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@synthigy/tooling",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Synthigy web components (data modeling, data console, log cockpit) and portal binaries",
5
5
  "author": "Robert Ger\u0161ak",
6
6
  "homepage": "https://github.com/synthigy/synthigy",