@eid-easy/eideasy-widget 2.172.1 → 2.172.3-beta.1

package/README.md

@@ -1,4 +1,4 @@
-<p align="center"><a href="https://eideasy.com/" target="_blank" rel="noopener noreferrer"><img width="300" src="https://eideasy.com/wp-content/uploads/2020/11/eid-easy-logo-1.png" alt="eID Easy logo"></a></p>
+<p align="center"><a href="https://eideasy.com/" target="_blank" rel="noopener noreferrer"><img width="300" src="https://assets.eideasy.com/brand/images/logo/eideasy-logo-black.svg" alt="eID Easy logo"></a></p>
 
 <p align="center">
   <a href="https://app.netlify.com/sites/eideasy-widget/deploys"><img src="https://api.netlify.com/api/v1/badges/75cb270d-cc4f-473c-9940-9d6effe6093a/deploy-status" alt="Netlify Status" style="max-width:100%;"></a>
@@ -13,4 +13,74 @@ to identify users or create electronic signatures through [eID Easy](https://eid
 You can see a demo implementation here: [https://demo.eideasy.com/login-widget](https://demo.eideasy.com/login-widget)
 
 ## Documentation
-The docs are available at https://eideasy-widget.docs.eideasy.com
+The client facing docs are available at https://eideasy-widget.docs.eideasy.com
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vite.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Compile and Minify for Production
+
+```sh
+npm run build
+```
+This will build the widget and output the resulting js to the `dist` directory.
+ 
+
+### Demo of the Production Build
+
+```sh
+npm run dev:prod-demo
+```
+This will first create a production build of the widget and then start a local server
+to serve the demo page that uses the production build of the widget.
+The demo page mimics the way our customers would use the widget in their own applications.
+
+
+### Run Unit Tests with [Vitest](https://vitest.dev/)
+
+```sh
+npm run test:unit
+```
+
+### Run End-to-End Tests with [Playwright](https://playwright.dev)
+
+```sh
+# Install browsers for the first run
+npx playwright install
+
+# When testing on CI, must build the project first
+npm run build
+
+# Runs the end-to-end tests
+npm run test:e2e
+# Runs the tests only on Chromium
+npm run test:e2e -- --project=chromium
+# Runs the tests of a specific file
+npm run test:e2e -- tests/example.spec.ts
+# Runs the tests in debug mode
+npm run test:e2e -- --debug
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+npm run lint
+```
+
+### Dev notes
+
+index.html is used to demo the widget in development mode.
+prod-build-demo.html is used to demo the widget in production mode.