1
1
mirror of https://github.com/primer/css.git synced 2025-01-07 06:51:03 +03:00
css/tools/generator-primer-module/app/templates/README.md

56 lines
1.6 KiB
Markdown
Raw Normal View History

2017-09-01 08:23:17 +03:00
# Primer CSS / <%= title %>
[![npm version](http://img.shields.io/npm/v/<%= module %>.svg)](https://www.npmjs.org/package/<%= module %>)
[![Build Status](https://travis-ci.org/primer/primer-css.svg?branch=master)](https://travis-ci.org/primer/primer-css)
> <%= description %>
This repository is a module of the full [primer-css][primer-css] repository.
## Install
This repository is distributed with [npm]. After [installing npm][install-npm], you can install `<%= module %>` with this command.
```
$ npm install --save <%= module %>
```
## 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 "<%= module %>/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
2017-09-07 01:33:18 +03:00
For a compiled **CSS** version of this module, an 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:
2017-09-01 08:23:17 +03:00
```
$ npm run build
```
## Documentation
<!-- %docs
title: <%= title %>
status: <%= status || "Experimental" %>
-->
2017-09-07 01:33:18 +03:00
<%= docs || "TODO: Write some documentation here." %>
2017-09-01 08:23:17 +03:00
<!-- %enddocs -->
## License
[MIT](./LICENSE) &copy; [GitHub](https://github.com/)
[primer-css]: https://github.com/primer/primer
[docs]: http://primercss.io/
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/