Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit d232543

Browse files
authored
update README with the provided Element containers (#190)
Signed-off-by: Kim Brose <kim.brose@nordeck.net>
1 parent 77c67eb commit d232543

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,27 +32,46 @@ A module to provide widget toggles.
3232

3333
- 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.
3434

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+
3552
## Getting Started
3653

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).
3855

3956
### How to Contribute
4057

4158
Please take a look at our [Contribution Guidelines](https://github.com/nordeck/.github/blob/main/docs/CONTRIBUTING.md).
4259

43-
### Requirements
60+
### Development
61+
62+
#### Requirements
4463

4564
You need to install Node.js (`>= 20.0.0`, prefer using an LTS version) and run
4665
`yarn` to work on this package.
4766

48-
### Installation
67+
#### Install Dependencies
4968

5069
After checkout, run `yarn install` to download the required dependencies
5170

5271
> [!WARNING]
5372
> Do not use `npm install` when working with this package.
5473
55-
### Available Scripts
74+
#### Available Scripts
5675

5776
In the project root directory, you can run:
5877

@@ -67,7 +86,7 @@ In the project root directory, you can run:
6786
change.
6887
- `yarn docker:build`: Builds a container from the output of `yarn build`.
6988

70-
### Versioning
89+
#### Versioning
7190

7291
This package uses automated versioning.
7392
Each change should be accompanied with a specification of the impact (`patch`, `minor`, or `major`) and a description of the change.

0 commit comments

Comments
 (0)