README.md in font-awesome-sass-mixins-0.1.2 vs README.md in font-awesome-sass-mixins-4.3.0
- old
+ new
@@ -1,2 +1,40 @@
# font-awesome-sass-mixins
For those of us who want to use Font Awesome without class tags and without loading every single class definition.
+
+
+### Installation
+
+```bash
+gem install font-awesome-sass-mixins
+```
+then
+
+```sass
+@import font-awesome-mixins
+```
+
+- Make sure you have the @font-face declaration somewhere in your SASS already. I may add that automatically in the near future.
+- Make sure your fonts directory is also setup and that your @font-face points at it. This gem cannot really help you with that, it's out of scope.
+
+### Usage
+
+```sass
+.my-element
+ +fa-icon(pencil)
+```
+
+### Compilation
+###### (no Rails or Compass hooks yet sorry)
+
+```bash
+sass -r font-awesome-sass-mixins my/sass/dir/styles.sass
+```
+
+### Current Feature
+
+- Basic icon inclusion
+
+### Future Feature
+
+- Convenience parameters for controlling attributes like color, size etc...
+