README.md

# Octicons

[![Hex Version](https://img.shields.io/hexpm/v/octicons.svg)](https://hex.pm/packages/octicons)
[![API Docs](https://img.shields.io/badge/api-docs-green.svg)](https://hexdocs.pm/octicons/)
[![License](https://img.shields.io/github/license/lee-dohm/octicons-ex.svg)](https://github.com/lee-dohm/octicons-ex/blob/master/LICENSE.md)
[![Ebert](https://ebertapp.io/github/lee-dohm/octicons-ex.svg)](https://ebertapp.io/github/lee-dohm/octicons-ex)

Provides the SVG versions of [GitHub's Octicons][octicons] to an Elixir application.

## Octicons Version

See [the documentation](https://hexdocs.pm/octicons/Octicons.html#version/0) on how to get the version of the packaged Octicons.

## License

All files except the contents of the `priv` directory: [MIT](LICENSE.md)

Files in `priv` are included from https://github.com/primer/octicons under the [MIT license][octicons-license] and are copyright GitHub, Inc.

[octicons]: https://octicons.github.com/
[octicons-license]: https://github.com/primer/octicons/blob/master/LICENSE