# @wearegenki/ui

FYI this is a meta-package which pulls in all the other @wearegenki/ui packages. It's convenient for quick prototyping but we recommended installing the specific package/s you need or at least a JS framework specific meta-package, e.g. `@wearegenki/ui-vue`, `@wearegenki/ui-marko`, or `@wearegenki/dev`.

TODO: Write me!

-----

© 2018 [We Are Genki](https://wearegenki.com)

# @wearegenki/ui

A friendly UI framework which aims to be straightforward, intuitive, and high performance.

**NOTE:** This is a meta-package which pulls in all the other @wearegenki/ui packages. It's convenient for quick prototyping but we recommended installing the specific package/s you need or at least a JS framework specific meta-package. See the [main README](https://github.com/WeAreGenki/ui/blob/master/README.md) for more info.

## Child meta-packages

| NPM Package | Notes |
|---------|-------|
| `@wearegenki/ui-vue` | Vue components and CSS. |
| `@wearegenki/ui-marko` | Marko components and CSS. |
| `@wearegenki/dev` | Development configs. |
| `@wearegenki/test` | Generic test suite with puppeteer. |
| `@wearegenki/test-vue` | Vue specific test suite. |
| `@wearegenki/test-marko` | Marko specific test suite. |

## Documentation

To see [live examples](https://ui.wearegenki.com/examples) and the docs, visit [ui.wearegenki.com](https://ui.wearegenki.com).

## Licence

`@wearegenki/ui` is an Apache-2.0 licensed open source project. See [LICENCE](https://github.com/WeAreGenki/ui/blob/master/LICENCE).

-----

© 2018 [We Are Genki](https://wearegenki.com)

Improve the @/ui package readme
Improve the @/ui package readme
