@ipscape/cumulus/README.md

A Vue.js component library by ipSCAPE

# ipSCAPE Cumulus component library

[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest) [![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)

A component library with Vue and Bootstrap.

## Live demo

See [Storybook](http://ipscape-component-library.s3-website-ap-southeast-2.amazonaws.com/storybook/)

## Getting started

Install the component library:

```
npm install @ipscape/cumulus
```

or

```
yarn add @ipscape/cumulus
```

Add the component library to your app:

```javascript
import Vue from 'vue';
import Cumulus from '@ipscape/cumulus';
import '@ipscape/cumulus/dist/cumulus.css';

Vue.use(Cumulus);
```

Use a component in your application. I.e. ips-badge:

```html
<template>
  <ips-badge variant="orange" variant-style="solid">This is a badge</ips-badge>
  <template></template
></template>
```

## License

[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://img.shields.io/badge/License-GPL%20v2-blue.svg) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)

Made with &#x2764; by [ipSCAPE](https://ipscape.com)

Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file.