Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 3.72 KB

README.md

File metadata and controls

62 lines (40 loc) · 3.72 KB

octicons cover light octicons cover dark

OpenProject's Primer Octicons

Octicons are a set of SVG icons built by GitHub forked by OpenProject for OpenProject

Libraries

This repository contains several libraries. Each of them is in the lib/ folder and gives access to Octicons on a different platform/language.

JavaScript

The octicons node.js library is the main JavaScript library. With a JavaScript API that can be used in a variety of applications.

Package Version
@openproject/octicons-angular
Node.js package with JavaScript API
npm version

Read more about the usage with Javascript here.

Ruby

Package Version
openproject-octicons
Ruby gem with Ruby API
Gem version
openproject-octicons_helper
Rails helper for using octicons
Gem version

Read more about the usage with Ruby here.

Contributing

Feedback, ideas, and bug reports

If you found a bug, have feedback about our Octicon Library, or an idea on how to improve it, please open a new issue in this repo using the appropriate issue template.

Adding or updating an icon

Read through our contributing guide if you want to add or update icons.

Release

Read through our release guide if you want to release a new version.

License

(c) GitHub, Inc.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

Code License: MIT Applies to all other files