https://github.com/frizbee/cryptofont-rails
A sleek webfont for your favourite cryptocurrencies. Featuring 88 icons. CryptoFont by @AMPoellmann (alexanderpoellmann.com)
https://github.com/frizbee/cryptofont-rails
Last synced: 5 months ago
JSON representation
A sleek webfont for your favourite cryptocurrencies. Featuring 88 icons. CryptoFont by @AMPoellmann (alexanderpoellmann.com)
- Host: GitHub
- URL: https://github.com/frizbee/cryptofont-rails
- Owner: frizbee
- License: mit
- Created: 2018-07-18T05:48:45.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-25T17:19:22.000Z (almost 8 years ago)
- Last Synced: 2025-04-12T19:13:25.704Z (about 1 year ago)
- Language: CSS
- Size: 641 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# cryptofont-rails
Cryptofont-rails provides the [Cryptofont](https://cryptofont.com/) web fonts and styles as Rails engine for use with the asset pipeline.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cryptofont-rails'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install cryptofont-rails
## Usage
In your `application.css`, include the css file:
```
/*
* require cryptofont
*/
```
Then restart your webserver if it was peviously running.
Congratulation! You now have cryptofont icon support.
### SASS Support
It you prefer SCSS, add this to your `application.css.scss` file:
```
@import "cryptofont";
```
If you use the SASS indented syntax, add this to your `application.css.sass` file:
```
@import cryptofont
```
## Helpers
There are also some helpers `cf_icon` that make your views better read and cleaner.
```ruby
cf_icon "btc"
# =>
cf_icon "ltc", text: "Litecoin"
# => Litecoin
cf_icon "eth", text: "Ethereum", right: true
# => Ethereum
cf_icon "dash 4x", text: "Dash"
# =>
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/frizbee/cryptofont-rails.
## License
* The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
* The font is licensed under the SIL OFL 1.1 http://scripts.sil.org/OFL
* The CSS files are licensed under the MIT License http://opensource.org/licenses/mit-license.htm
* Attribution is not required, but much appreciated CryptoFont by @AMPoellmann (alexanderpoellmann.com)