@eid-easy/eideasy-browser-client/README.md

eideasy-browser-client is a handy tool that you can use to handle the client side parts of the identification and signing flows when using eID Easy API.

<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-browser-client/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>
  <a href="https://github.com/eideasy/eideasy-browser-client/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@eid-easy/eideasy-browser-client" alt="license badge" style="max-width:100%;"></a>
  <a href="https://www.npmjs.com/package/@eid-easy/eideasy-browser-client"><img src="https://img.shields.io/npm/v/@eid-easy/eideasy-browser-client" alt="version badge" style="max-width:100%;"></a>
</p>

# eID Easy Browser Client
eideasy-browser-client is a handy js package that you can use to handle the client side parts of the identification and signing flows when using eID Easy API.

## Documentation
The docs are available at https://eideasy-browser-client.docs.eideasy.com

### Running locally
To run the documentation locally, follow these steps:
1. Install the required dependencies by running `npm install` in the project root.
2. Start the documentation server by running `npm run docs:dev`.
3. Open your browser and navigate to `http://localhost:8087` to view the documentation.