An open API service indexing awesome lists of open source software.

https://github.com/cfpb/cf-icons

:warning: THIS REPO IS DEPRECATED :warning: Custom icon font for Capital Framework.
https://github.com/cfpb/cf-icons

Last synced: 7 months ago
JSON representation

:warning: THIS REPO IS DEPRECATED :warning: Custom icon font for Capital Framework.

Awesome Lists containing this project

README

          

# :warning: THIS REPO IS DEPRECATED (1/15/2016) :warning:
Please migrate to using [capital-framework](https://github.com/cfpb/capital-framework).

# cf-icons

[![Build Status](https://img.shields.io/travis/cfpb/cf-icons.svg)](https://travis-ci.org/cfpb/cf-icons)
[![Dependency Status](https://gemnasium.com/cfpb/cf-icons.svg)](https://gemnasium.com/cfpb/cf-icons)

Custom icon font for Capital Framework.
This component can be used by itself, but it was made for Capital Framework, a new front end framework developed at the [Consumer Financial Protection Bureau](https://cfpb.github.io/).

- [View the docs](https://cfpb.github.io/cf-icons/docs/)
- [See the raw demo](https://cfpb.github.io/cf-icons/demo/)

The current version number can be found in [bower.json](bower.json#L3)
and follows [Semantic Versioning 2.0](http://semver.org/).
Release notes are recorded on the
[Releases page](https://github.com/cfpb/cf-icons/releases/).

If you would like to take advantage of more components or if you're new to
Capital Framework, we encourage you to [start here](https://cfpb.github.io/capital-framework/).

![](screenshot.png)

## Getting involved

We welcome your feedback and contributions.

- [Find out about contributing](CONTRIBUTING.md)
- File a bug using this [handy template](https://github.com/cfpb/cf-icons/issues/new?body=%23%23%20URL%0D%0D%0D%23%23%20Actual%20Behavior%0D%0D%0D%23%23%20Expected%20Behavior%0D%0D%0D%23%23%20Steps%20to%20Reproduce%0D%0D%0D%23%23%20Screenshot&labels=bug)

## Running tests

Before contributing to our codebase, please ensure all tests pass. After cloning this repository to your machine, run:

```sh
$ npm install
$ npm test
```

---

## Open source licensing info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)

---

## Credits and references

Docs and demo built with the excellent [Topdoc](https://github.com/topcoat/topdoc/).

Fonts generated by [Font Squirrel](http://www.fontsquirrel.com/tools/webfont-generator).

Helper classes, mixins and inspiration from
[Font Awesome](https://github.com/FortAwesome/Font-Awesome),
which is [MIT licensed](http://fontawesome.io/license/).