Primer CSS Avatars
![Build Status](https://travis-ci.org/primer/avatars.svg?branch=master)
Avatars are images that users can set as their profile picture. On GitHub, they’re always going to be rounded squares. They can be custom photos, uploaded by users, or generated as Identicons as a placeholder.
This repository is a module of the full primer-css repository.
Documentation
You can read more about avatars in the docs.
Install
This repository is distributed with npm. After installing npm, you can install primer-avatars
with this command.
$ npm install --save primer-avatars
Usage
The source files included are written in Sass (scss
) You can simply point your sass include-path
at your node_modules
directory and import it like this.
@import "primer-avatars/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
$ npm run build
Related
License
MIT © GitHub