@cloudfour/patterns/README.md

Front-end patterns for cloudfour.com

<p align="center"><img src="https://cloudfour.com/android-chrome-512x512.png" alt="" width="128" height="128"></p>

# Cloud Four Patterns

[![NPM version](http://img.shields.io/npm/v/@cloudfour/patterns.svg)](https://www.npmjs.org/package/@cloudfour/patterns) [![Build Status](https://github.com/cloudfour/cloudfour.com-patterns/workflows/CI/badge.svg)](https://github.com/cloudfour/cloudfour.com-patterns/actions?query=workflow%3ACI) [![Netlify Status](https://api.netlify.com/api/v1/badges/1923e350-3172-409a-9361-b04d54d1c3b4/deploy-status?branch=main)](https://app.netlify.com/sites/cloudfour-patterns/deploys?filter=main)

[View Netlify Preview →](https://cloudfour-patterns.netlify.app)

## Installation

<!---
  note that this content is duplicated between readme.md and welcome.stories.mdx
  be sure to make any changes to both files!
-->

The package includes both the compiled code and the source files. So you can either include the compiled CSS and JS directly, or load the source files using your own build system. If you use the source files, you'll need to compile them yourself using Sass and PostCSS.

You can add the pattern library package as a dependency to your JavaScript application using npm:

```
npm install @cloudfour/patterns
```

## Contributing

To learn how to run this project locally, modify existing patterns, or create new ones, please see the [contribution guidelines for this project](CONTRIBUTING.md).