@wpmudev/sui-css/README.md

SUI CSS Framework, the WPMU DEV Products styles library.

[![npm](https://img.shields.io/npm/v/@wpmudev/sui-css?color=blue&style=for-the-badge)](https://www.npmjs.com/package/@wpmudev/sui-css)
[![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/wpmudev/sui-css?color=orange&filename=packages%2Flayout%2Fpackage.json&label=core&style=for-the-badge)](https://github.com/wpmudev/sui-css/)
[![License: GPLv3](https://img.shields.io/badge/License-GPL%20v3-blue.svg?color=green&style=for-the-badge)](http://www.gnu.org/licenses/gpl-3.0)

# **Shared UI CSS Framework**

WPMU DEV's Shared UI CSS Framework includes a wide range of shorthand utility classes to modify an element's appearance in a plugin.

This framework's primary goal is to deliver a method of styling elements with as little friction as possible. Our framework allows us to use our Design Tokens via memorable CSS-based utility classes.

## **Installation**

Before proceeding further, please ensure you have [Node.js](https://nodejs.org/) installed. You can install the latest version via their website.

Run in your project root directory (where `package.json` lives):

```
npm install @wpmudev/sui-css --save-dev
```

## **Documentation**

Please, read through our common guidelines before starting to contribute on any of our projects:

-   [General Guidelines](https://github.com/wpmudev/sui-docs/guidelines.md)
-   [Contributions Guidelines](https://github.com/wpmudev/sui-docs/contributions.md)
-   [Release Guidelines](https://github.com/wpmudev/sui-docs/release.md)