README.md in compass-fontcustom-1.3.0 vs README.md in compass-fontcustom-1.3.1
- old
+ new
@@ -1,18 +1,16 @@
# 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, 2.0.0 and 2.1.3.
+Tested on Ruby 2.0, 2.1, 2.2, 2.3 and 2.4.
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:
@@ -30,15 +28,15 @@
## 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.
+- `fontcustom_discard_manifest`
+ Boolean to configure to delete the manifest file after each run.
+- `fontcustom_options`
+ A hash to pass native options to FontCustom.
## Usage
Syntactically it works like Compass' sprites feature.
You can let Font Custom generate your fonts upon Compass' css compilation: