# inkeep-widget-library

A React component library for use with Inkeep, Inc.'s search and chat service.

## Prerequisites

- You must be added to the npm @inkeep organization to access the library at
  https://www.npmjs.com/package/@inkeep/inkeep-widget-library
- To use the package in a production environment with a CI/CD workflow, you need to generate an
  access token in npm following the instructions at
  https://docs.npmjs.com/using-private-packages-in-a-ci-cd-workflow/

## Installation

1. Make sure you are using a terminal context that has an authenticated npm user with access to the
   @inkeep organization.
2. Install the package:
   - Using yarn: `yarn add @inkeep/inkeep-widget-library`
   - Using npm: `npm install @inkeep/inkeep-widget-library`
3. Install the peer dependencies of the package in your project:
   - Using the `install-peerdeps` package with yarn:
     `install-peerdeps @inkeep/inkeep-widget-library --only-peers -Y`
   - Manually with yarn: Check the `peerDependencies` section of the package.json file and install
     each dependency using `yarn add <dependency>`
   - Manually with npm: Check the `peerDependencies` section of the package.json file and install
     each dependency using `npm install <dependency>`

## Usage

Ask for access to the widget library documentation.

## License

This project is licensed under the Inkeep, Inc. Customer License (IICL) v1.0. The terms and
conditions of the IICL apply to all users who are Inkeep, Inc. customers. Users can modify and
extend the software as they wish, but only as long as they are Inkeep, Inc. customers. For more
details, see the [LICENSE](./LICENSE) file in the project root.
