construct-ui/readme.md

A Mithril.js UI library

<p align="center">
  <a href="https://vrimar.github.io/construct-ui" rel="noopener" target="_blank"><img width="60" src="https://raw.githubusercontent.com/vrimar/construct-ui/master/docs/src/logo.svg?sanitize=true" alt="Construct-UI logo"></a></p>
</p>

<h1 align="center">Construct-UI</h1>

<div align="center">

### A [Mithril.js](https://github.com/MithrilJS/mithril.js) UI library.

[![npm package](https://img.shields.io/npm/v/construct-ui/latest.svg)](https://www.npmjs.com/package/construct-ui)
![Tests](https://github.com/vrimar/construct-ui/actions/workflows/run-tests.yml/badge.svg)
[![Gitter](https://img.shields.io/gitter/room/vrimar/construct-ui.svg)](https://gitter.im/construct-ui/Lobby)

</div>

## Documentation
Check out the [documentation website](https://vrimar.github.io/construct-ui) for installation instructions and getting started.

## Playground
Check out [codesandbox](https://codesandbox.io/s/x7zzjovzyz) examples for basic usage.

## Development
1. `npm i`
2. `npm run generate:icons`
3. `npm run generate:docs`
4. `npm run watch:docs`

## Credits
Inspired by [blueprint](https://github.com/palantir/blueprint), [polythene](https://github.com/ArthurClemens/polythene) and [ant-design](https://github.com/ant-design/ant-design).