web-eid / web-eid.js

Add secure authentication and digital signing with electronic ID smart cards to web apps with the Web eID JavaScript library
https://web-eid.eu
MIT License
39 stars 18 forks source link

Add prebuilt web-eid.js file #25

Closed joellimberg closed 2 years ago

joellimberg commented 2 years ago

From the readme, under InstallationWithout a module system: ”Use the dist/iife build. It exposes the webeid object globally.”

The “dist/iife build” is not actually in the repo or under releases.

It would be clearer if there was a clear link to a browser-usable js file. Currently, the built files can only be found under GitHub action build artifacts (eg https://github.com/web-eid/web-eid.js/actions/runs/2058087830)

Muzosh commented 2 years ago

I'm not sure if this helps you, but you can build it yourself by cloning the repository and following this: https://github.com/web-eid/web-eid.js#development.

joellimberg commented 2 years ago

Yeah, I figured out how to get the built file (it seems to be easiest to use the build artifacts, although finding the correct stable release is still not trivial).

I just think the repo should also provide usable and official distribution files to make it easier for other implementers :)

taneltm commented 2 years ago

Thanks @joellimberg for pointing it out!

The current setup is intentional:

The place to download a stable pre-built version of the library should be under https://github.com/web-eid/web-eid.js/releases. However, thanks you your comment, I now noticed that the pre-built versions are not there and that's definitely something we should fix!

joellimberg commented 2 years ago

Yep, it doesn't really matter where exactly the built files are, as long they exist and are linked from the README :)

mrts commented 2 years ago

The pre-built package is now attached to release v2.0.1 and README has been updated with the corresponding link.

Thanks for pointing this out!