You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 5, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+24-5Lines changed: 24 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,27 +32,46 @@ A module to provide widget toggles.
32
32
33
33
- See the [Readme of the `element-web-widget-toggles-module`](./packages/element-web-widget-toggles-module/README.md) for instructions on how to install it in Element.
34
34
35
+
### Prebuilt Element Containers With Modules
36
+
37
+
We provide some version combinations of Element Web with the modules as a container under [packages](https://github.com/nordeck/element-web-modules/pkgs/container/element-web-modules).
38
+
These are built automatically by our CI and not tested further, but should otherwise be ready to use.
39
+
40
+
The tagging scheme for the container signifies the versions of the components going into it: `<component>-[v if tagged version]<tag or git commit hash>`.
41
+
This pattern repeats up to 5 times for the 5 possible components:
42
+
43
+
-`ew` Element Web
44
+
-`g` Guest module
45
+
-`od` openDesk module
46
+
-`wl` Widget Lifecycle module
47
+
-`wt` Widget Toggles module
48
+
49
+
For example, the tag `ew-v1.11.86-g-v2.0.0-od-v0.5.0-wl-v1.0.1-wt-v0.1.0` signifies the combination of all 5 latest stable releases at the time of writing.
50
+
As another example, `ew-v1.11.84-g-v2.0.0-od-ae0b6e6-wl-54f75f3` is Element Web release 1.11.84, Guest module release 2.0.0, different git versions for the openDesk and Widget Lifecycle modules, and the Widget Toggles module was not included.
51
+
35
52
## Getting Started
36
53
37
-
Development on the module happens at [GitHub](https://github.com/nordeck/element-web-modules).
54
+
Development on the modules happens at [GitHub](https://github.com/nordeck/element-web-modules).
38
55
39
56
### How to Contribute
40
57
41
58
Please take a look at our [Contribution Guidelines](https://github.com/nordeck/.github/blob/main/docs/CONTRIBUTING.md).
42
59
43
-
### Requirements
60
+
### Development
61
+
62
+
#### Requirements
44
63
45
64
You need to install Node.js (`>= 20.0.0`, prefer using an LTS version) and run
46
65
`yarn` to work on this package.
47
66
48
-
###Installation
67
+
#### Install Dependencies
49
68
50
69
After checkout, run `yarn install` to download the required dependencies
51
70
52
71
> [!WARNING]
53
72
> Do not use `npm install` when working with this package.
54
73
55
-
### Available Scripts
74
+
####Available Scripts
56
75
57
76
In the project root directory, you can run:
58
77
@@ -67,7 +86,7 @@ In the project root directory, you can run:
67
86
change.
68
87
-`yarn docker:build`: Builds a container from the output of `yarn build`.
69
88
70
-
### Versioning
89
+
####Versioning
71
90
72
91
This package uses automated versioning.
73
92
Each change should be accompanied with a specification of the impact (`patch`, `minor`, or `major`) and a description of the change.
0 commit comments