README.md in fontcustom-1.0.0.pre vs README.md in fontcustom-1.0.0.pre2
- old
+ new
@@ -1,34 +1,44 @@
-FontCustom v0.1.3
-==========
+# FontCustom v0.1.4
+**(v1.0.0 is currently in pre-release until docs are updated. Install the latest with `gem install fontcustom --pre`)**
+
**Generate custom icon webfonts from the comfort of the command line.**
-[Full documentation](http://fontcustom.github.com/fontcustom/)<br/>
+[Full documentation](http://fontcustom.com)<br/>
+[Changelog](https://github.com/FontCustom/fontcustom/blob/master/CHANGELOG.md)<br/>
[Feedback and issues](https://github.com/FontCustom/fontcustom/issues)
+## Installation
-Installation
-------------
-
```sh
# Requires FontForge
brew install fontforge eot-utils ttfautohint
gem install fontcustom
```
+## Quick Start
-Usage
------
-
```sh
-fontcustom compile path/to/vectors # Compile icons and css to path/to/fontcustom/*
-fontcustom watch path/to/vectors # Watch for changes
+fontcustom compile path/to/vectors # Compiles into `fontcustom`
+fontcustom compile path/to/vectors -o assets/fonts # Compiles into `assets/fonts`
+fontcustom watch path/to/vectors -t=scss preview # Compiles when vectors are changed/added/deleted
+ # and includes a scss partial and glyph preview
+
+fontcustom help # to see all options
```
-Optional second parameter allows you to specify an output directory.
+## Config
-Need help?
+To avoid finger-fatigue, include a fontcustom.yml configuration file with your vectors:
```sh
-fontcustom --help
+fontcustom config path/to/vectors # Creates annotated config file
+vim path/to/vectors/fontcustom.yml # Edit your fontcustom options
```
+
+---
+
+[Contributor Guidelines](https://github.com/FontCustom/fontcustom/blob/master/CONTRIBUTING.md)<br/>
+[Licenses](https://github.com/FontCustom/fontcustom/blob/master/LICENSES.txt)
+
+Brought to you by [@endtwist](https://github.com/endtwist) and [@ezYZ](https://github.com/ezYZ)