@attivio/suit/README.md

Attivio SUIT, the Search UI Toolkit, is a library for creating search clients for searching the Attivio platform.

# SUIT

[![TravisCI][build-badge]][build]
[![npmjs][npm-badge]][npm]

The Search User Interface Toolkit, or SUIT, is a library for creating search
applications on top of the index in an Attivio, Elasticsearch or Solr installation.

## React
SUIT is built using React and is intended to be used by other applications also using React. To ensure your application functions as expected, the version of react in your application should match the version of react used in the version of suit you are using.

SUIT v0.1.x - Uses React `v15.6.2`.
SUIT v1.x.x - Uses React `v16.8.6`.

For more information on updating from react 15 to react 16 in your own library see the react docs:
https://github.com/facebook/react/releases?after=16.1.0-rc
https://reactjs.org/blog/2017/09/26/react-v16.0.html

## Documentation
For documentation about SUIT, how to use it, and how to contribute to it, see the [SUIT Documentation site](https://attivio.github.io/suit/)

## Issues
To report an issue, please click the Issues tab above and click the *New Issue* button. 
Please provide a detailed description of the issue with any code excerpts, logs or screenshots which help describe the issue. You can also contribute fixes and other improvbements to the SUIT library by creating pull requests; see the [Documentation](https://attivio.github.io/suit/) for details on how to do this.

## Attivio
For more information on Attivio and the Attivio Platform, please visit our website at [http://www.attivio.com](http://www.attivio.com).

[build-badge]: https://travis-ci.org/attivio/suit.svg
[build]: https://travis-ci.org/attivio/suit

[npm-badge]: https://img.shields.io/npm/v/@attivio/suit.svg
[npm]: https://www.npmjs.org/package/@attivio/suit