README.md in compass-fontcustom-1.2.0 vs README.md in compass-fontcustom-1.3.0
- old
+ new
@@ -1,17 +1,18 @@
# Compass::Fontcustom
[![Build Status](https://travis-ci.org/glaszig/compass-fontcustom.png?branch=master)](https://travis-ci.org/glaszig/compass-fontcustom)
[![Gem Version](https://badge.fury.io/rb/compass-fontcustom.png)](http://badge.fury.io/rb/compass-fontcustom)
[![Test Coverage](https://coveralls.io/repos/glaszig/compass-fontcustom/badge.png?branch=master)](https://coveralls.io/r/glaszig/compass-fontcustom)
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/glaszig/compass-fontcustom/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
[![endorse](https://api.coderwall.com/glaszig/endorsecount.png)](https://coderwall.com/glaszig)
This is my attempt of integrating [Font Custom](http://fontcustom.com) with [Compass](http://compass-style.org).
## Requirements
-Made for ruby 1.9+. Tested on 1.9.3 and 2.0.0.
+Made for ruby 1.9+. Tested on 1.9.3, 2.0.0 and 2.1.3.
You'll need to have fontforge and the [WOFF font toolset](http://people.mozilla.com/~jkew/woff) installed as outlined in the Font Custom [installation instructions](http://fontcustom.com/#installation).
## Installation
Add this line to your application's Gemfile:
@@ -24,10 +25,22 @@
And then execute:
$ bundle
+## Configuration
+
+Compass::Fontcustom adds the following configuration options to Compass.
+Just add these to your project's `config/compass.rb`.
+
+- `fontcustom_hash`
+ Enables/disables Fontcustom file name hashing.
+- `fontcustom_input_paths`
+ Array of paths where to search for SVG files to build custom fonts from.
+- `fontcustom_fonts_path`
+ Path to put generated font files in.
+
## Usage
Syntactically it works like Compass' sprites feature.
You can let Font Custom generate your fonts upon Compass' css compilation:
@@ -61,23 +74,10 @@
> **Attention**
> Generated CSS class names will be normalized and reserved characters removed.
> That means if you have a glyph file name of `a_R3ally-eXotic f1Le+Name.svg` the generated class name will be `.icon-myfont-a_R3ally-eXotic-f1Le-Name`.
-## Configuration options
-
-### Filename hashing
-
-You can choose to disable file name hashes if you're already using an asset pipeline which handles this for you:
-Use the `fontcustom_hash` option in `config.rb`
-
-```ruby
-compass_config do |config|
- config.fontcustom_hash = false
-end
-```
-
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -87,5 +87,8 @@
## License
[MIT](https://raw.github.com/glaszig/compass-fontcustom/master/LICENSE)
[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/233dd6a31787ce3672d5e92e97a76965 "githalytics.com")](http://githalytics.com/glaszig/compass-fontcustom)
+
+
+