1
1
mirror of https://github.com/primer/css.git synced 2024-12-01 12:42:32 +03:00
css/modules/primer-utilities/README.md

49 lines
1.6 KiB
Markdown
Raw Normal View History

2017-11-09 20:41:18 +03:00
# Primer Utilities
2017-05-11 07:56:23 +03:00
2017-11-15 21:08:26 +03:00
[![npm version](https://img.shields.io/npm/v/primer-utilities.svg)](https://www.npmjs.org/package/primer-utilities)
2017-11-09 20:41:18 +03:00
[![Build Status](https://travis-ci.org/primer/primer.svg?branch=master)](https://travis-ci.org/primer/primer)
2017-05-11 07:56:23 +03:00
> There are a handful of utilities in Primer for quick behaviors, floats, colors, alignment, and more.
2017-11-09 20:41:18 +03:00
This repository is a module of the full [primer][primer] repository.
2017-05-11 07:56:23 +03:00
## Install
This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer-utilities` with this command.
```
$ npm install --save primer-utilities
```
## Usage
The source files included are written in [Sass][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this.
```scss
@import "primer-utilities/index.scss";
```
You can also import specific portions of the module by importing those partials from the `/lib/` folder. _Make sure you import any requirements along with the modules._
## Build
For a compiled **css** version of this module, a npm script is included that will output a css version to `build/build.css` The built css file is also included in the npm package.
```
$ npm run build
```
## Documentation
You can read more about utilities in the [docs folder](./docs/).
## License
[MIT](./LICENSE) © [GitHub](https://github.com/)
2017-11-09 20:41:18 +03:00
[primer]: https://github.com/primer/primer
[docs]: http://primer.github.io/
2017-05-11 07:56:23 +03:00
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/